llvmorg-github-actions[bot] wrote:

<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-clang

Author: Hardik Kumar (hardikxk)

<details>
<summary>Changes</summary>

A grammar nit found in the description of the Clang Diagnostic Subsystem is 
improved.

Replace the instruction mentioning the use of "slash-newline" for writing 
multiple diagnostics with the appropriate "forward slash" as that's what is 
actually used for separting multiple diagnostics into more than one line.

The change makes it more obvious on how to implement multi-line diagnostics by 
dropping the slightly ambigious slash-newline.

---
Full diff: https://github.com/llvm/llvm-project/pull/213432.diff


1 Files Affected:

- (modified) clang/docs/InternalsManual.rst (+3-2) 


``````````diff
diff --git a/clang/docs/InternalsManual.rst b/clang/docs/InternalsManual.rst
index 4b263565bc27f..bf314dab23061 100644
--- a/clang/docs/InternalsManual.rst
+++ b/clang/docs/InternalsManual.rst
@@ -50,7 +50,7 @@ when the code is incorrect or dubious.  In Clang, each 
diagnostic produced has
 :ref:`SourceLocation <SourceLocation>` to "put the caret", and a severity
 (e.g., ``WARNING`` or ``ERROR``).  They can also optionally include a number of
 arguments to the diagnostic (which fill in "%0"'s in the string) as well as a
-number of source ranges that related to the diagnostic.
+number of source ranges that are related to the diagnostic.
 
 In this section, we'll be giving examples produced by the Clang command line
 driver, but diagnostics can be :ref:`rendered in many different ways
@@ -3631,7 +3631,8 @@ diagnostics:
   int A = B; // expected-error {{use of undeclared identifier 'B'}}
 
 You can place as many diagnostics on one line as you wish. To make the code
-more readable, you can use slash-newline to separate out the diagnostics.
+more readable, you can use forward slash to separate out the diagnostics into
+multiple lines.
 
 Alternatively, it is possible to specify the line on which the diagnostic
 should appear by appending ``@<line>`` to ``expected-<type>``, for example:

``````````

</details>


https://github.com/llvm/llvm-project/pull/213432
_______________________________________________
cfe-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Reply via email to