[Documentation] Make options section in Clang-tidy readability-uppercase-literal...
authorEugene Zelenko <eugene.zelenko@gmail.com>
Tue, 4 Dec 2018 21:19:08 +0000 (21:19 +0000)
committerEugene Zelenko <eugene.zelenko@gmail.com>
Tue, 4 Dec 2018 21:19:08 +0000 (21:19 +0000)
llvm-svn: 348302

clang-tools-extra/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst

index 583a6ca..e3da086 100644 (file)
@@ -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.