[clang-tools-extra] r348302 - [Documentation] Make options section in Clang-tidy readability-uppercase-literal-suffix consistent with other checks.

[Roman Lebedev via cfe-commits]

On Wed, Dec 5, 2018 at 12:21 AM Eugene Zelenko via cfe-commits
<cfe-commits at lists.llvm.org> wrote:
>
> Author: eugenezelenko
> Date: Tue Dec  4 13:19:08 2018
> New Revision: 348302
>
> URL: http://llvm.org/viewvc/llvm-project?rev=348302&view=rev
> Log:
> [Documentation] Make options section in Clang-tidy readability-uppercase-literal-suffix consistent with other checks.
Thank you!

> Modified:
>     clang-tools-extra/trunk/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst
>
> Modified: clang-tools-extra/trunk/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst
> URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst?rev=348302&r1=348301&r2=348302&view=diff
> ==============================================================================
> --- clang-tools-extra/trunk/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst (original)
> +++ clang-tools-extra/trunk/docs/clang-tidy/checks/readability-uppercase-literal-suffix.rst Tue Dec  4 13:19:08 2018
> @@ -25,13 +25,21 @@ All valid combinations of suffixes are s
>
>    ...
>
> -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.
>
>
> _______________________________________________
> cfe-commits mailing list
> cfe-commits at lists.llvm.org
> http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits