summaryrefslogtreecommitdiff
path: root/clang-tools-extra/docs
diff options
context:
space:
mode:
authorEugene Zelenko <eugene.zelenko@gmail.com>2018-12-03 22:35:40 +0000
committerEugene Zelenko <eugene.zelenko@gmail.com>2018-12-03 22:35:40 +0000
commit13a6810e3853f77a4342105b6f09ecad3b5d5964 (patch)
tree5a91ce131794a61ab3343fce614303e92b37a0c1 /clang-tools-extra/docs
parent59f731c97613cecc2c286cf01b62d124566bb8a9 (diff)
[Documentation] Fix formatting and wrap up to 80 characters in Clang-tidy readability-uppercase-literal-suffix documentation.
Diffstat (limited to 'clang-tools-extra/docs')
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst19
1 files changed, 10 insertions, 9 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 e869fbee4a2..583a6ca4123 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
@@ -4,14 +4,14 @@ readability-uppercase-literal-suffix
====================================
`cert-dcl16-c` redirects here as an alias for this check.
-By default, only the suffixes that begin with 'l' ("l", "ll", "lu", "llu",
-but not "u", "ul", "ull") are diagnosed by that alias.
+By default, only the suffixes that begin with ``l`` (``l``, ``ll``, ``lu``,
+``llu``, but not ``u``, ``ul``, ``ull``) are diagnosed by that alias.
`hicpp-uppercase-literal-suffix` redirects here as an alias for this check.
Detects when the integral literal or floating point (decimal or hexadecimal)
-literal has a non-uppercase suffix and provides a fix-it-hint
-with the uppercase suffix.
+literal has a non-uppercase suffix and provides a fix-it hint with the uppercase
+suffix.
All valid combinations of suffixes are supported.
@@ -25,13 +25,14 @@ 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.
+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.
For example, given a list ``L;uL``:
+
* ``l`` -> ``L``
* ``L`` will be kept as is.
* ``ul`` -> ``uL``