aboutsummaryrefslogtreecommitdiff
path: root/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
commit9feccd35b56a8672809d88002a0ed643943df6a1 (patch)
treecc0b99e24686e4c2f32e02d99dfdca007b7acc17 /docs
parentea8047b969dc86c6e780af6b62615cd07fe178c9 (diff)
downloadclang-tools-extra-9feccd35b56a8672809d88002a0ed643943df6a1.tar.gz
[Documentation] Make options section in Clang-tidy readability-uppercase-literal-suffix consistent with other checks.
git-svn-id: https://llvm.org/svn/llvm-project/clang-tools-extra/trunk@348302 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst20
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.