[llvm-branch-commits] [clang-tools-extra] [clang-tidy][docs] Rewrite readability check docs to Markdown [2/5] (PR #221529)

[Zeyi Xu via llvm-branch-commits]

================
@@ -1,147 +1,148 @@
-.. title:: clang-tidy - readability-identifier-length
+```{title} clang-tidy - readability-identifier-length
+```
 
-readability-identifier-length
-=============================
+# readability-identifier-length
 
 This check finds variables and function parameters whose length are too short.
 The desired name length is configurable. Special short names which should be
 ignored can be specified. Local variables with short names can also be ignored
 if they are short-lived.
 
-Options
--------
+## Options
 
 The following options are described below:
 
- - :option:`MinimumVariableNameLength`, :option:`IgnoredVariableNames`
- - :option:`MinimumBindingNameLength`, :option:`IgnoredBindingNames`
- - :option:`MinimumParameterNameLength`, :option:`IgnoredParameterNames`
- - :option:`MinimumLoopCounterNameLength`, :option:`IgnoredLoopCounterNames`
- - :option:`MinimumExceptionNameLength`,
-   :option:`IgnoredExceptionVariableNames`
- - :option:`LineCountThreshold`
-
-.. option:: MinimumVariableNameLength
-
-    All variables (other than loop counter, exception names and function
-    parameters) are expected to have at least a length of
-    `MinimumVariableNameLength` (default is `3`). Setting it to `0` or `1`
-    disables the check entirely.
-
-    .. code-block:: c++
-
-      int i = 42;    // warns that 'i' is too short
-
-.. option:: IgnoredVariableNames
-
-    Specifies a regular expression for variable names that are
-    to be ignored. The default value is empty, thus no names are ignored.
-
-.. option:: MinimumBindingNameLength
-
-    All variables introduced by structured bindings are expected to have at
-    least a length of `MinimumBindingNameLength` (default is `2`). Setting it
-    to `0` or `1` disables the check entirely.
-
-    .. code-block:: c++
-
-      auto [a] = get_result();    // warns that 'a' is too short
-
-.. option:: IgnoredBindingNames
-
-    Specifies a regular expression for variable names introduced by structured
-    bindings that are to be ignored. The default value is `^[_]$`, to allow the
-    use of the `_` idiom to specify that the value is discarded on purpose.
-
-.. option:: MinimumParameterNameLength
-
-    All function parameter names are expected to have a length of at least
-    `MinimumParameterNameLength` (default is `3`). Setting it to `0` or `1`
-    disables the check entirely.
-
-    .. code-block:: c++
-
-         int doubler(int x)   // warns that x is too short
-         {
-            return 2 * x;
-         }
-
-.. option:: IgnoredParameterNames
-
-    Specifies a regular expression for parameters that are to be ignored.
-    The default value is `^[n]$` for historical reasons.
-
-.. option:: MinimumLoopCounterNameLength
-
-    Loop counter variables are expected to have a length of at least
-    `MinimumLoopCounterNameLength` characters (default is `2`). Setting it to
-    `0` or `1` disables the check entirely.
-
-    .. code-block:: c++
-
-      // This warns that 'q' is too short.
-      for (int q = 0; q < size; ++ q) {
-         // ...
-      }
-
-.. option:: IgnoredLoopCounterNames
-
-    Specifies a regular expression for counter names that are to be ignored.
-    The default value is `^[ijk_]$`; the first three symbols for historical
-    reasons and the last one since it is frequently used as a "don't care"
-    value, specifically in tools such as Google Benchmark.
-
-    .. code-block:: c++
-
-      // This does not warn by default, for historical reasons.
-      for (int i = 0; i < size; ++ i) {
-          // ...
-      }
-
-.. option:: MinimumExceptionNameLength
-
-    Exception clause variables are expected to have a length of at least
-    `MinimumExceptionNameLength` (default is `2`). Setting it to `0` or `1`
-    disables the check entirely.
-
-    .. code-block:: c++
-
-      try {
-          // ...
-      }
-      // This warns that 'e' is too short.
-      catch (const std::exception& x) {
-          // ...
-      }
-
-.. option:: IgnoredExceptionVariableNames
-
-    Specifies a regular expression for exception variable names that are to
-    be ignored. The default value is `^[e]$` mainly for historical reasons.
-
-    .. code-block:: c++
-
-      try {
-          // ...
-      }
-      // This does not warn by default, for historical reasons.
-      catch (const std::exception& e) {
-          // ...
-      }
-
-.. option:: LineCountThreshold
-
-    Defines the minimum number of lines required between declaration and last
-    use for a diagnostic to be issued. The default value for this option is 0,
-    which corresponds to all variables being flagged. This option only affects
-    the behavior regarding local variables: a warning is always issued when a
-    global variable has a short name, because globals can potentially be used
-    across multiple files.
-
-    .. code-block:: c++
-
-      // In this example, a warning will be issued if LineCountThreshold < N
-      int a = 0;      // First line (declaration line)
-      a = 1;          // Second line
-                      // ...
-      last_use_of(a); // N-th line
+- {option}`MinimumVariableNameLength`, {option}`IgnoredVariableNames`
+- {option}`MinimumBindingNameLength`, {option}`IgnoredBindingNames`
+- {option}`MinimumParameterNameLength`,
+  [`IgnoredParameterNames`](#readability-identifier-length-ignored-parameter-names)
----------------
zeyi2 wrote:

I have to use this format because `IgnoredParameterNames` both exist in:
- readability-identifier-length
- bugprone-easily-swappable-parameters

With 
```
{option}`IgnoredParameterNames`
```

It will be linked to the bugprone page.

https://github.com/llvm/llvm-project/pull/221529