Skip to content

[clang-tidy][NFC][docs] Use single tick for 'false' and 'true' values in options #128362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,20 @@ Options
.. option:: UseCXXStaticCastsInCppSources

When suggesting fix-its for C++ code, should C++-style ``static_cast<>()``'s
be suggested, or C-style casts. Defaults to ``true``.
be suggested, or C-style casts. Defaults to `true`.

.. option:: UseCXXHeadersInCppSources

When suggesting to include the appropriate header in C++ code,
should ``<cstddef>`` header be suggested, or ``<stddef.h>``.
Defaults to ``true``.
Defaults to `true`.

.. option:: IgnoreConstantIntExpr

If the multiplication operands are compile-time constants (like literals or
are ``constexpr``) and fit within the source expression type, do not emit a
diagnostic or suggested fix. Only considers expressions where the source
expression is a signed integer type. Defaults to ``false``.
expression is a signed integer type. Defaults to `false`.

Examples:

Expand Down
2 changes: 1 addition & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/err33-c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ This check is an alias of check :doc:`bugprone-unused-return-value <../bugprone/
with a fixed set of functions.

Suppressing issues by casting to ``void`` is enabled by default and can be
disabled by setting `AllowCastToVoid` option to ``false``.
disabled by setting `AllowCastToVoid` option to `false`.

The check corresponds to a part of CERT C Coding Standard rule `ERR33-C.
Detect and handle standard library errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ lives.

When set to true convert loops when in C++20 or later mode using
``std::ranges::reverse_view``.
Default value is ``true``.
Default value is `true`.

.. option:: MakeReverseRangeFunction

Expand Down