salman-javed-nz updated this revision to Diff 381703.
salman-javed-nz added a comment.
Standardize spelling of "e.g." and "i.e."
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D112356/new/
https://reviews.llvm.org/D112356
Files:
clang-tools-extra/docs/clang-tidy/checks/bugprone-easily-swappable-parameters.rst
clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-string-compare.rst
clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
clang-tools-extra/docs/clang-tidy/checks/concurrency-mt-unsafe.rst
clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-narrowing-conversions.rst
clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst
Index: clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst
+++ clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst
@@ -3,7 +3,7 @@
modernize-use-nullptr
=====================
-The check converts the usage of null pointer constants (eg. ``NULL``, ``0``)
+The check converts the usage of null pointer constants (e.g. ``NULL``, ``0``)
to use the new C++11 ``nullptr`` keyword.
Example
Index:
clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-narrowing-conversions.rst
===================================================================
---
clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-narrowing-conversions.rst
+++
clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-narrowing-conversions.rst
@@ -3,7 +3,7 @@
cppcoreguidelines-narrowing-conversions
=======================================
-Checks for silent narrowing conversions, e.g: ``int i = 0; i += 0.1;``. While
+Checks for silent narrowing conversions, e.g.: ``int i = 0; i += 0.1;``. While
the issue is obvious in this former example, it might not be so in the
following: ``void MyClass::f(double d) { int_member_ += d; }``.
Index: clang-tools-extra/docs/clang-tidy/checks/concurrency-mt-unsafe.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/concurrency-mt-unsafe.rst
+++ clang-tools-extra/docs/clang-tidy/checks/concurrency-mt-unsafe.rst
@@ -12,7 +12,7 @@
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: clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
+++ clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
@@ -3,7 +3,7 @@
bugprone-virtual-near-miss
==========================
-Warn if a function is a near miss (ie. the name is very similar and the
function
+Warn if a function is a near miss (i.e. the name is very similar and the
function
signature is the same) to a virtual function from a base class.
Example:
Index:
clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-string-compare.rst
===================================================================
---
clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-string-compare.rst
+++
clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-string-compare.rst
@@ -14,7 +14,7 @@
if (!strcmp(...)) // Won't warn
if (strcmp(...) != 0) // Won't warn
-Checks that compare function results (i,e, ``strcmp``) are compared to valid
+Checks that compare function results (i.e., ``strcmp``) are compared to valid
constant. The resulting value is
.. code::
Index:
clang-tools-extra/docs/clang-tidy/checks/bugprone-easily-swappable-parameters.rst
===================================================================
---
clang-tools-extra/docs/clang-tidy/checks/bugprone-easily-swappable-parameters.rst
+++
clang-tools-extra/docs/clang-tidy/checks/bugprone-easily-swappable-parameters.rst
@@ -154,7 +154,7 @@
``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: clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst
+++ clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst
@@ -3,7 +3,7 @@
modernize-use-nullptr
=====================
-The check converts the usage of null pointer constants (eg. ``NULL``, ``0``)
+The check converts the usage of null pointer constants (e.g. ``NULL``, ``0``)
to use the new C++11 ``nullptr`` keyword.
Example
Index: clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-narrowing-conversions.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-narrowing-conversions.rst
+++ clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-narrowing-conversions.rst
@@ -3,7 +3,7 @@
cppcoreguidelines-narrowing-conversions
=======================================
-Checks for silent narrowing conversions, e.g: ``int i = 0; i += 0.1;``. While
+Checks for silent narrowing conversions, e.g.: ``int i = 0; i += 0.1;``. While
the issue is obvious in this former example, it might not be so in the
following: ``void MyClass::f(double d) { int_member_ += d; }``.
Index: clang-tools-extra/docs/clang-tidy/checks/concurrency-mt-unsafe.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/concurrency-mt-unsafe.rst
+++ clang-tools-extra/docs/clang-tidy/checks/concurrency-mt-unsafe.rst
@@ -12,7 +12,7 @@
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: clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
+++ clang-tools-extra/docs/clang-tidy/checks/bugprone-virtual-near-miss.rst
@@ -3,7 +3,7 @@
bugprone-virtual-near-miss
==========================
-Warn if a function is a near miss (ie. the name is very similar and the function
+Warn if a function is a near miss (i.e. the name is very similar and the function
signature is the same) to a virtual function from a base class.
Example:
Index: clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-string-compare.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-string-compare.rst
+++ clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-string-compare.rst
@@ -14,7 +14,7 @@
if (!strcmp(...)) // Won't warn
if (strcmp(...) != 0) // Won't warn
-Checks that compare function results (i,e, ``strcmp``) are compared to valid
+Checks that compare function results (i.e., ``strcmp``) are compared to valid
constant. The resulting value is
.. code::
Index: clang-tools-extra/docs/clang-tidy/checks/bugprone-easily-swappable-parameters.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/bugprone-easily-swappable-parameters.rst
+++ clang-tools-extra/docs/clang-tidy/checks/bugprone-easily-swappable-parameters.rst
@@ -154,7 +154,7 @@
``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::
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
