Skip to content

[clang-tidy] Refactor: removed typos in 'AllowedTypes' option in various checks #122957

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.

Sign up for GitHub

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
nicovank merged 3 commits into from
Jan 29, 2025
Merged

[clang-tidy] Refactor: removed typos in 'AllowedTypes' option in various checks #122957

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c49e1e
[clang-tidy] Fix: typos in 'AllowedTypes' option in various checks
vbvictor Jan 14, 2025
be68e91
[clang-tidy] more fixes to docs
vbvictor Jan 15, 2025
33baf69
[clang-tidy] improved docs
vbvictor Jan 28, 2025
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
6 changes: 3 additions & 3 deletions clang-tools-extra/docs/clang-tidy/checks/performance/for-range-copy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ Options
A semicolon-separated list of names of types allowed to be copied in each
iteration. Regular expressions are accepted, e.g. `[Rr]ef(erence)?$` matches
every type with suffix `Ref`, `ref`, `Reference` and `reference`. The default
Copy link
Contributor

@nicovank nicovank Jan 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@EugeneZelenko should other single ticks also be replaced by double ticks?
For reference, generated HTML: https://clang.llvm.org/extra/clang-tidy/checks/performance/for-range-copy.html

Copy link
Contributor

@EugeneZelenko EugeneZelenko Jan 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Single back-ticks are for option names and values. Double back-ticks for language constructs. Since Ref, ref, etc. refers to types, double-ticks should be used.

Copy link
Contributor

@nicovank nicovank Jan 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you 👍 @vbvictor Can you please also make this change?

Copy link
Contributor Author

@vbvictor vbvictor Jan 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicovank, yes, I can make this change.
As far as I understand only Ref, ref, Reference and reference should be changed but not [Rr]ef(erence)?$.
It got a little tricky for me since Ref only refers to a suffix of a potential c++ type, so it doesn't fall into the double back-ticks category.

Copy link
Contributor

@nicovank nicovank Jan 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO it also makes sense to double tick the regex (so everything here). Probably slightly easier on the eyes as a code block when generated than an italicized string.,

Copy link
Contributor Author

@vbvictor vbvictor Jan 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected to double-ticks plus found and fixed one more file with same errors: clang-tools-extra/docs/clang-tidy/checks/bugprone/assert-side-effect.rst.

is empty. If a name in the list contains the sequence `::` it is matched
against the qualified typename (i.e. `namespace::Type`, otherwise it is
matched against only the type name (i.e. `Type`).
is empty. If a name in the list contains the sequence `::`, it is matched
against the qualified type name (i.e. ``namespace::Type``), otherwise it is
matched against only the type name (i.e. ``Type``).
6 changes: 3 additions & 3 deletions ...ls-extra/docs/clang-tidy/checks/performance/unnecessary-copy-initialization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ Options
A semicolon-separated list of names of types allowed to be initialized by
copying. Regular expressions are accepted, e.g. `[Rr]ef(erence)?$` matches
every type with suffix `Ref`, `ref`, `Reference` and `reference`. The default
is empty. If a name in the list contains the sequence `::` it is matched
against the qualified typename (i.e. `namespace::Type`, otherwise it is
matched against only the type name (i.e. `Type`).
is empty. If a name in the list contains the sequence `::`, it is matched
against the qualified type name (i.e. ``namespace::Type``), otherwise it is
matched against only the type name (i.e. ``Type``).

.. option:: ExcludedContainerTypes

Expand Down
6 changes: 3 additions & 3 deletions clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-value-param.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@ Options
A semicolon-separated list of names of types allowed to be passed by value.
Regular expressions are accepted, e.g. `[Rr]ef(erence)?$` matches every type
with suffix `Ref`, `ref`, `Reference` and `reference`. The default is
empty. If a name in the list contains the sequence `::` it is matched against
the qualified typename (i.e. `namespace::Type`, otherwise it is matched
against only the type name (i.e. `Type`).
empty. If a name in the list contains the sequence `::`, it is matched against
the qualified type name (i.e. ``namespace::Type``), otherwise it is matched
against only the type name (i.e. ``Type``).
Loading