[clang-tools-extra] 52bbdad - [clang-tidy][docs] Post-commit feedback on D74669

[Jonathan Roelofs via cfe-commits]

Author: Jonathan Roelofs
Date: 2020-03-09T16:51:41-06:00
New Revision: 52bbdad7d63fd060d102b3591b433d116a982255

URL: https://github.com/llvm/llvm-project/commit/52bbdad7d63fd060d102b3591b433d116a982255
DIFF: https://github.com/llvm/llvm-project/commit/52bbdad7d63fd060d102b3591b433d116a982255.diff

LOG: [clang-tidy][docs] Post-commit feedback on D74669

Added: 
    

Modified: 
    clang-tools-extra/docs/ReleaseNotes.rst
    clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-include.rst

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index aa9ff71ef7f8..3da1433934c4 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -82,6 +82,13 @@ New checks
 
   Checks for usages of identifiers reserved for use by the implementation.
 
+- New :doc:`bugprone-suspicious-include
+  <clang-tidy/checks/bugprone-suspicious-include>` check.
+
+  Finds cases where an include refers to what appears to be an implementation
+  file, which often leads to hard-to-track-down ODR violations, and diagnoses
+  them.
+
 - New :doc:`cert-oop57-cpp
   <clang-tidy/checks/cert-oop57-cpp>` check.
 
@@ -98,12 +105,6 @@ New checks
 
   Finds recursive functions and diagnoses them.
 
-- New :doc:`bugprone-suspicious-include
-  <clang-tidy/checks/bugprone-suspicious-include>` check.
-
-  Finds includes that appear to be referring to implementation files (which
-  tends to cause ODR violations), and diagnoses them.
-
 New check aliases
 ^^^^^^^^^^^^^^^^^
 

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-include.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-include.rst
index 95a90c4f1fb8..9d6c41da504e 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-include.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-include.rst
@@ -3,8 +3,8 @@
 bugprone-suspicious-include
 ===========================
 
-The checker detects various cases when an include refers to what appears to be
-an implementation file, which often leads to hard-to-track-down ODR violations.
+The check detects various cases when an include refers to what appears to be an
+implementation file, which often leads to hard-to-track-down ODR violations.
 
 Examples:
 
@@ -20,7 +20,7 @@ Options
 -------
 .. option:: HeaderFileExtensions
 
-   Default value: ";h;hh;hpp;hxx"
+   Default value: `";h;hh;hpp;hxx"`
    A semicolon-separated list of filename extensions of header files (the
    filename extensions should not contain a "." prefix). For extension-less
    header files, use an empty string or leave an empty string between ";"
@@ -28,6 +28,6 @@ Options
 
 .. option:: ImplementationFileExtensions
 
-   Default value: "c;cc;cpp;cxx"
+   Default value: `"c;cc;cpp;cxx"`
    Likewise, a semicolon-separated list of filename extensions of
    implementation files.