summaryrefslogtreecommitdiff
path: root/clang-tools-extra/docs
diff options
context:
space:
mode:
authorEugene Zelenko <eugene.zelenko@gmail.com>2018-12-04 21:19:08 +0000
committerEugene Zelenko <eugene.zelenko@gmail.com>2018-12-04 21:19:08 +0000
commita78258c0b156cf984134d43a65c4a02246960262 (patch)
tree87e71af578ca7b1d7cc32f302435e356799394cf /clang-tools-extra/docs
parent164431454e472289a6513c7ed2a6e55e80d1a405 (diff)
[Documentation] Make options section in Clang-tidy readability-uppercase-literal-suffix consistent with other checks.
Diffstat (limited to 'clang-tools-extra/docs')
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst20
1 files changed, 14 insertions, 6 deletions
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst
index 583a6ca4123..e3da086492b 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst
+++ b/clang-tools-extra/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.