[PATCH] D112356: [NFC] Tidy up spelling, grammar, and inconsistencies in clang-tidy documentation

Salman Javed via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Fri Oct 22 20:27:57 PDT 2021


salman-javed-nz created this revision.
salman-javed-nz added reviewers: aaron.ballman, whisperity, kazu.
salman-javed-nz added a project: clang-tools-extra.
Herald added subscribers: carlosgalvezp, rnkovacs.
salman-javed-nz requested review of this revision.

- Fix spelling and grammatical mistakes found across the .rst files.

- Standardize to US English spelling for words such as "behavior" and "specialization".

- Remove repeated words, e.g. "for a a larger user input".

- Standardize spelling of "e.g." and "i.e."

- Replace curly quote characters (‘ ’ “ ”) with standard straight ones (' "). Replace en-dash (`–`) with standard hyphen (`-`). In both cases, the latter is used more often in the doc files and is easier to type.

- Change double spaces after commas and periods to single space.

- Ensure there is a empty line at the end of each .rst file.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D112356

Files:
  clang-tools-extra/docs/clang-tidy/checks/cert-dcl21-cpp.rst
  clang-tools-extra/docs/clang-tidy/checks/cert-err09-cpp.rst
  clang-tools-extra/docs/clang-tidy/checks/cert-oop11-cpp.rst


Index: clang-tools-extra/docs/clang-tidy/checks/cert-oop11-cpp.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/cert-oop11-cpp.rst
+++ clang-tools-extra/docs/clang-tidy/checks/cert-oop11-cpp.rst
@@ -13,4 +13,4 @@
 OOP11-CPP. Do not copy-initialize members or base classes from a move
 constructor. However, all of the CERT recommendations have been removed from
 public view, and so their justification for the behavior of this check requires
-an account on their wiki to view.
\ No newline at end of file
+an account on their wiki to view.
Index: clang-tools-extra/docs/clang-tidy/checks/cert-err09-cpp.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/cert-err09-cpp.rst
+++ clang-tools-extra/docs/clang-tidy/checks/cert-err09-cpp.rst
@@ -12,4 +12,4 @@
 This check corresponds to the CERT C++ Coding Standard recommendation
 ERR09-CPP. Throw anonymous temporaries. However, all of the CERT recommendations
 have been removed from public view, and so their justification for the behavior
-of this check requires an account on their wiki to view.
\ No newline at end of file
+of this check requires an account on their wiki to view.
Index: clang-tools-extra/docs/clang-tidy/checks/cert-dcl21-cpp.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/cert-dcl21-cpp.rst
+++ clang-tools-extra/docs/clang-tidy/checks/cert-dcl21-cpp.rst
@@ -21,4 +21,4 @@
 DCL21-CPP. Overloaded postfix increment and decrement operators should return a
 const object. However, all of the CERT recommendations have been removed from
 public view, and so their justification for the behavior of this check requires
-an account on their wiki to view.
\ No newline at end of file
+an account on their wiki to view.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D112356.381700.patch
Type: text/x-patch
Size: 1888 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20211023/21b98c71/attachment.bin>


More information about the cfe-commits mailing list