[llvm-branch-commits] [clang-tools-extra] [clang-tidy][docs] Rewrite readability check docs to Markdown [5/5] (PR #222033)
via llvm-branch-commits
llvm-branch-commits at lists.llvm.org
Tue Sep 8 08:47:35 PDT 2026
================
@@ -29,90 +28,83 @@ The heuristics themselves are implemented by considering pairs of strings, and
are symmetric, so in the following there is no distinction on which string is
the argument name and which string is the parameter name.
-Equality
-^^^^^^^^
+### Equality
The most trivial heuristic, which compares the two strings for case-insensitive
equality.
-.. _abbreviation_heuristic:
+(abbreviation_heuristic)=
-Abbreviation
-^^^^^^^^^^^^
+### Abbreviation
Common abbreviations can be specified which will deem the strings similar if
the abbreviated and the abbreviation stand together.
-For example, if ``src`` is registered as an abbreviation for ``source``, then
+For example, if `src` is registered as an abbreviation for `source`, then
the following code example will be warned about.
-.. code-block:: c++
+```c++
+void foo(int source, int x);
- void foo(int source, int x);
-
- foo(b, src);
+foo(b, src);
+```
The abbreviations to recognise can be configured with the
-:ref:`Abbreviations<opt_Abbreviations>` check option.
+{option}`Abbreviations` option.
----------------
EugeneZelenko wrote:
```suggestion
{option}`Abbreviations`.
```
https://github.com/llvm/llvm-project/pull/222033
More information about the llvm-branch-commits
mailing list