Skip to content

Commit d8afa57

Browse files
[clang-tidy] Fix documentation typos (NFC)
1 parent a4cb5ae commit d8afa57

13 files changed

+16
-16
lines changed

clang-tools-extra/docs/clang-tidy/checks/abseil-no-internal-dependencies.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ abseil-no-internal-dependencies
55

66
Warns if code using Abseil depends on internal details. If something is in a
77
namespace that includes the word "internal", code is not allowed to depend upon
8-
it beaucse it’s an implementation detail. They cannot friend it, include it,
8+
it because it’s an implementation detail. They cannot friend it, include it,
99
you mention it or refer to it in any way. Doing so violates Abseil's
1010
compatibility guidelines and may result in breakage. See
1111
https://abseil.io/about/compatibility for more information.

clang-tools-extra/docs/clang-tidy/checks/abseil-time-subtraction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Examples:
2525
int x;
2626
absl::Time t;
2727

28-
// Original - absl::Duration result and first operand is a absl::Time.
28+
// Original - absl::Duration result and first operand is an absl::Time.
2929
absl::Duration d = absl::Seconds(absl::ToUnixSeconds(t) - x);
3030

3131
// Suggestion - Perform subtraction in the Time domain instead.

clang-tools-extra/docs/clang-tidy/checks/bugprone-fold-init-type.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ the latter, with ``operator+`` by default. This can cause loss of precision
1111
through:
1212

1313
- Truncation: The following code uses a floating point range and an int
14-
initial value, so trucation will happen at every application of ``operator+``
14+
initial value, so truncation will happen at every application of ``operator+``
1515
and the result will be `0`, which might not be what the user expected.
1616

1717
.. code-block:: c++

clang-tools-extra/docs/clang-tidy/checks/bugprone-redundant-branch-condition.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ is an operand of a logical "and" (``&&``) or a logical "or" (``||``) operator:
4141
4242
In the first case (logical "and") the suggested fix is to remove the redundant
4343
condition variable and keep the other side of the ``&&``. In the second case
44-
(logical "or") the whole ``if`` is removed similarily to the simple case on the
44+
(logical "or") the whole ``if`` is removed similarly to the simple case on the
4545
top.
4646

4747
The condition of the outer ``if`` statement may also be a logical "and" (``&&``)

clang-tools-extra/docs/clang-tidy/checks/bugprone-signal-handler.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ and has an alias name ``cert-sig30-c``.
2020

2121
.. option:: AsyncSafeFunctionSet
2222

23-
Selects wich set of functions is considered as asynchronous-safe
23+
Selects which set of functions is considered as asynchronous-safe
2424
(and therefore allowed in signal handlers). Value ``minimal`` selects
2525
a minimal set that is defined in the CERT SIG30-C rule and includes functions
2626
``abort()``, ``_Exit()``, ``quick_exit()`` and ``signal()``. Value ``POSIX``

clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-memory-comparison.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ arguments. The following cases are covered:
88

99
**Case 1: Non-standard-layout type**
1010

11-
Comparing the object representaions of non-standard-layout objects may not
11+
Comparing the object representations of non-standard-layout objects may not
1212
properly compare the value representations.
1313

1414
**Case 2: Types with no unique object representation**
1515

16-
Objects with the same value may not have the same object representaion.
16+
Objects with the same value may not have the same object representation.
1717
This may be caused by padding or floating-point types.
1818

1919
See also:

clang-tools-extra/docs/clang-tidy/checks/bugprone-too-small-loop-variable.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ a larger user input.
3333
Upper limit for the magnitude bits of the loop variable. If it's set the check
3434
filters out those catches in which the loop variable's type has more magnitude
3535
bits as the specified upper limit. The default value is 16.
36-
For example, if the user sets this option to 31 (bits), then a 32-bit ``unsigend int``
36+
For example, if the user sets this option to 31 (bits), then a 32-bit ``unsigned int``
3737
is ignored by the check, however a 32-bit ``int`` is not (A 32-bit ``signed int``
3838
has 31 magnitude bits).
3939

clang-tools-extra/docs/clang-tidy/checks/bugprone-unhandled-exception-at-new.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ is allowed to propagate out of the function (exception handler is checked for
2121
types ``std::bad_alloc``, ``std::exception``, and catch-all handler).
2222
The check assumes that any user-defined ``operator new`` is either
2323
``noexcept`` or may throw an exception of type ``std::bad_alloc`` (or derived
24-
from it). Other exception types or exceptions occuring in the objects's
24+
from it). Other exception types or exceptions occurring in the objects's
2525
constructor are not taken into account.

clang-tools-extra/docs/clang-tidy/checks/cert-oop57-cpp.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ Options
1111

1212
.. option:: MemSetNames
1313

14-
Specify extra functions to flag that act similarily to ``memset``.
14+
Specify extra functions to flag that act similarly to ``memset``.
1515
Specify names in a semicolon delimited list.
1616
Default is an empty string.
1717
The check will detect the following functions:
1818
`memset`, `std::memset`.
1919

2020
.. option:: MemCpyNames
2121

22-
Specify extra functions to flag that act similarily to ``memcpy``.
22+
Specify extra functions to flag that act similarly to ``memcpy``.
2323
Specify names in a semicolon delimited list.
2424
Default is an empty string.
2525
The check will detect the following functions:
@@ -28,7 +28,7 @@ Options
2828

2929
.. option:: MemCmpNames
3030

31-
Specify extra functions to flag that act similarily to ``memcmp``.
31+
Specify extra functions to flag that act similarly to ``memcmp``.
3232
Specify names in a semicolon delimited list.
3333
Default is an empty string.
3434
The check will detect the following functions:

clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-narrowing-conversions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Options
4444
.. option:: WarnWithinTemplateInstantiation
4545

4646
When `true`, the check will warn on narrowing conversions within template
47-
instantations. `false` by default.
47+
instantiations. `false` by default.
4848

4949
.. option:: WarnOnEquivalentBitWidth
5050

clang-tools-extra/docs/clang-tidy/checks/google-upgrade-googletest-case.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,5 @@ becomes
4949

5050
For better consistency of user code, the check renames both virtual and
5151
non-virtual member functions with matching names in derived types. The check
52-
tries to provide a only warning when a fix cannot be made safely, as is the case
52+
tries to provide only a warning when a fix cannot be made safely, as is the case
5353
with some template and macro uses.

clang-tools-extra/docs/clang-tidy/checks/hicpp-no-assembler.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ hicpp-no-assembler
55

66
Check for assembler statements. No fix is offered.
77

8-
Inline assembler is forbidden by the `High Intergrity C++ Coding Standard
8+
Inline assembler is forbidden by the `High Integrity C++ Coding Standard
99
<http://www.codingstandard.com/section/7-5-the-asm-declaration/>`_
1010
as it restricts the portability of code.

clang-tools-extra/docs/clang-tidy/checks/readability-redundant-member-init.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Options
2929

3030
When `true`, the check will ignore unnecessary base class initializations
3131
within copy constructors, since some compilers issue warnings/errors when
32-
base classes are not explicitly intialized in copy constructors. For example,
32+
base classes are not explicitly initialized in copy constructors. For example,
3333
``gcc`` with ``-Wextra`` or ``-Werror=extra`` issues warning or error
3434
``base class 'Bar' should be explicitly initialized in the copy constructor``
3535
if ``Bar()`` were removed in the following example:

0 commit comments

Comments
 (0)