[clang-tools-extra] 724b40a - [clang-tidy][Docs] Update docs per post-commit review

[Kadir Cetinkaya via cfe-commits]

Author: Kadir Cetinkaya
Date: 2023-08-08T16:16:51+02:00
New Revision: 724b40a1379f7c116473a02a3cec4d341c475b46

URL: https://github.com/llvm/llvm-project/commit/724b40a1379f7c116473a02a3cec4d341c475b46
DIFF: https://github.com/llvm/llvm-project/commit/724b40a1379f7c116473a02a3cec4d341c475b46.diff

LOG: [clang-tidy][Docs] Update docs per post-commit review

Added: 
    

Modified: 
    clang-tools-extra/docs/ReleaseNotes.rst
    clang-tools-extra/docs/clang-tidy/checks/misc/include-cleaner.rst

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index 815237656a4035..dbd2fbf6de6d42 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -180,6 +180,10 @@ Changes in existing checks
   <clang-tidy/checks/llvm/namespace-comment>` check to provide fixes for
   ``inline`` namespaces in the same format as :program:`clang-format`.
 
+- Improved :doc:`misc-include-cleaner
+  <clang-tidy/checks/misc/include-cleaner>` check by adding option
+  `DeduplicateFindings` to output one finding per symbol occurence.
+
 - Improved :doc:`modernize-loop-convert
   <clang-tidy/checks/modernize/loop-convert>` to support for-loops with
   iterators initialized by free functions like ``begin``, ``end``, or ``size``.
@@ -192,9 +196,6 @@ Changes in existing checks
   <clang-tidy/checks/readability/identifier-naming>` check to emit proper
   warnings when a type forward declaration precedes its definition.
 
-- Misc-include-cleaner check has option `DeduplicateFindings` to output one
-  finding per occurence of a symbol.
-
 Removed checks
 ^^^^^^^^^^^^^^
 

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/misc/include-cleaner.rst b/clang-tools-extra/docs/clang-tidy/checks/misc/include-cleaner.rst
index d56bb4526ff015..e40335b2543b29 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/misc/include-cleaner.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc/include-cleaner.rst
@@ -37,4 +37,4 @@ Options
 .. option:: DeduplicateFindings
 
    A boolean that controls whether the check should deduplicate findings for the
-   same symbol. Defaults to true.
+   same symbol. Defaults to `true`.