diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst b/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst index 583a6ca4..e3da0864 100644 --- a/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst +++ b/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst @@ -25,13 +25,21 @@ All valid combinations of suffixes are supported. ... -Optionally, a list of the destination suffixes can be provided. When the suffix -is found, a case-insensitive lookup in that list is made, and if a replacement -is found that is different from the current suffix, then the diagnostic is -issued. This allows for fine-grained control of what suffixes to consider and -what their replacements should be. +Options +------- -For example, given a list ``L;uL``: +.. option:: NewSuffixes + + Optionally, a list of the destination suffixes can be provided. When the + suffix is found, a case-insensitive lookup in that list is made, and if a + replacement is found that is different from the current suffix, then the + diagnostic is issued. This allows for fine-grained control of what suffixes to + consider and what their replacements should be. + +Example +^^^^^^^ + +Given a list `L;uL`: * ``l`` -> ``L`` * ``L`` will be kept as is. |