Revert "Make minor fixes to docs based on post-commit review of commit 5de69e1"
authorSalman Javed <mail@salmanjaved.org>
Fri, 12 Nov 2021 09:42:18 +0000 (22:42 +1300)
committerSalman Javed <mail@salmanjaved.org>
Fri, 12 Nov 2021 09:42:38 +0000 (22:42 +1300)
Sphinx buildbot failing.
This reverts commit 735e4332e2a63e5f0a04f91472fa2403c7d37fe3.

clang-tools-extra/docs/clang-tidy/checks/bugprone-easily-swappable-parameters.rst
clang-tools-extra/docs/clang-tidy/checks/concurrency-mt-unsafe.rst
clang-tools-extra/docs/clang-tidy/checks/google-build-namespaces.rst
clang-tools-extra/docs/clang-tidy/checks/google-global-names-in-headers.rst
clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst
clang-tools-extra/docs/clang-tidy/checks/misc-definitions-in-headers.rst
clang-tools-extra/docs/clang-tidy/checks/readability-suspicious-call-argument.rst

index 47970bfbbc400a644c82697bfd257be6a8c8d436..dad4205858a8ec75df116729b0c06fd94b460de5 100644 (file)
@@ -154,7 +154,7 @@ noisiness.
       ``a < b``.
     * The parameters are further passed to the same function to the same
       parameter of that function, of the same overload.
-      E.g. ``f(a, 1)`` and ``f(b, 2)`` to some ``f(T, int)``.
+      e.g. ``f(a, 1)`` and ``f(b, 2)`` to some ``f(T, int)``.
 
       .. note::
 
index 4e46ba1edc34f77fb6a8074e838399fd77f3e1ea..67d8f99ab45bb6f19358eb16dd9189713c154f68 100644 (file)
@@ -12,7 +12,7 @@ Note that using some thread-unsafe functions may be still valid in
 concurrent programming if only a single thread is used (e.g. setenv(3)),
 however, some functions may track a state in global variables which
 would be clobbered by subsequent (non-parallel, but concurrent) calls to
-a related function. E.g. the following code suffers from unprotected
+a related function. e.g. the following code suffers from unprotected
 accesses to a global state:
 
 .. code-block:: c++
index ca40f99eef6fc9376e1627f00b643ae56ebdfb35..69c01d372cba31fe183e53e3df254d36c5f1ecbd 100644 (file)
@@ -20,5 +20,5 @@ Options
    A comma-separated list of filename extensions of header files (the filename
    extensions should not include "." prefix). Default is "h,hh,hpp,hxx".
    For header files without an extension, use an empty string (if there are no
-   other desired extensions) or leave an empty element in the list. E.g.,
+   other desired extensions) or leave an empty element in the list. e.g.,
    "h,hh,hpp,hxx," (note the trailing comma).
index 32740eade003919dc2365f279f879d99694017ed..88ba90668f1f5cae71b435d32d7f262de6049429 100644 (file)
@@ -17,5 +17,5 @@ Options
    A comma-separated list of filename extensions of header files (the filename
    extensions should not contain "." prefix). Default is "h".
    For header files without an extension, use an empty string (if there are no
-   other desired extensions) or leave an empty element in the list. E.g.,
+   other desired extensions) or leave an empty element in the list. e.g.,
    "h,hh,hpp,hxx," (note the trailing comma).
index b27002ad606a8f8a2603109acefb46894ea62505..58233ecac6ae3a42a53071fb265cb5b1ed831c27 100644 (file)
@@ -13,5 +13,5 @@ Options
    A comma-separated list of filename extensions of header files (the filename
    extensions should not include "." prefix). Default is "h,hh,hpp,hxx".
    For header files without an extension, use an empty string (if there are no
-   other desired extensions) or leave an empty element in the list. E.g.,
+   other desired extensions) or leave an empty element in the list. e.g.,
    "h,hh,hpp,hxx," (note the trailing comma).
index a1fa09a25ca0c1b881f1a1afdd98b65fdff12a81..82a5052df986d73ffc878f3a0bf72d700479c82e 100644 (file)
@@ -95,7 +95,7 @@ Options
    A comma-separated list of filename extensions of header files (the filename
    extensions should not include "." prefix). Default is "h,hh,hpp,hxx".
    For header files without an extension, use an empty string (if there are no
-   other desired extensions) or leave an empty element in the list. E.g.,
+   other desired extensions) or leave an empty element in the list. e.g.,
    "h,hh,hpp,hxx," (note the trailing comma).
 
 .. option:: UseHeaderFileExtension
index e1308df15bbcb97f3f068601485d130e1c5b59a7..fd567f331bfd2e392fac2393d33cd210809058aa 100644 (file)
@@ -109,10 +109,10 @@ This heuristic can be configured with :ref:`bounds<opt_Bounds>`.
 The default bounds are: below `50`\% dissimilar and above `66`\% similar.
 This heuristic is case-sensitive.
 
-Jaro--Winkler distance (as `JaroWinkler`)
+Jaro-Winkler distance (as `JaroWinkler`)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The `Jaro--Winkler distance <http://en.wikipedia.org/wiki/Jaro–Winkler_distance>`_
+The `Jaro-Winkler distance <http://en.wikipedia.org/wiki/Jaro–Winkler_distance>`_
 is an edit distance like the Levenshtein distance.
 It is calculated from the amount of common characters that are sufficiently
 close to each other in position, and to-be-changed characters.
@@ -125,10 +125,10 @@ This heuristic can be configured with :ref:`bounds<opt_Bounds>`.
 The default bounds are: below `75`\% dissimilar and above `85`\% similar.
 This heuristic is case-insensitive.
 
-Sørensen--Dice coefficient (as `Dice`)
+Sørensen-Dice coefficient (as `Dice`)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The `Sørensen--Dice coefficient <http://en.wikipedia.org/wiki/Sørensen–Dice_coefficient>`_
+The `Sørensen-Dice coefficient <http://en.wikipedia.org/wiki/Sørensen–Dice_coefficient>`_
 was originally defined to measure the similarity of two sets.
 Formally, the coefficient is calculated by dividing `2 * #(intersection)` with
 `#(set1) + #(set2)`, where `#()` is the cardinality function of sets.