[PATCH] D23918: [clang-tidy docs] Add missing option docs.

[Eugene Zelenko via cfe-commits]

Eugene.Zelenko added a comment.

General comments:

- I think //default is XYZ// is better then //XYZ by default//.

- There are discrepancies: option represent//ing// and option represent//s//.

I think will be good idea to involve native English speaker in review.


================
Comment at: docs/clang-tidy/checks/google-readability-namespace-comments.rst:11
@@ +10,3 @@
+
+Options
+-------
----------------
This documentation is redirect, so options description should be moved to llvm-namespace-comment.rst.

================
Comment at: docs/clang-tidy/checks/google-readability-namespace-comments.rst:14
@@ +13,3 @@
+
+.. option:: ShortNamespaceLines;
+
----------------
Unnecessary semicolon at the end. Same below.

================
Comment at: docs/clang-tidy/checks/google-runtime-int.rst:27
@@ +26,2 @@
+
+   A string represents type suffix. `` by default.
----------------
Will empty string displayed? May be it should be expressed in words?

================
Comment at: docs/clang-tidy/checks/misc-move-constructor-init.rst:22
@@ +21,3 @@
+   by default.
+
+
----------------
Unnecessary empty line.

================
Comment at: docs/clang-tidy/checks/misc-move-constructor-init.rst:26
@@ +25,3 @@
+
+   When non-zero, the checker is also used to implement cert-oop11-cpp. `0` by
+   default.
----------------
s/checker/check/.  I think will be good idea to provide link to cert-oop11-cpp.rst.

================
Comment at: docs/clang-tidy/checks/misc-suspicious-missing-comma.rst:49
@@ +48,3 @@
+   An unsigned integer represents minimal size of a string literals array to be
+   considered by the checker. `5U` by default.
+
----------------
s/checker/check/

================
Comment at: docs/clang-tidy/checks/misc-suspicious-string-compare.rst:55
@@ +54,3 @@
+
+   A string represents the name of detecting string compare function. `` by
+   default.
----------------
Will empty string displayed? May be it should be expressed in words?

================
Comment at: docs/clang-tidy/checks/modernize-replace-auto-ptr.rst:73
@@ -72,1 +72,3 @@
 
+
+Options
----------------
Unnecessary empty string.

================
Comment at: docs/clang-tidy/checks/modernize-replace-auto-ptr.rst:79
@@ +78,3 @@
+
+   A string specifying which include-style is used, `llvm` or `google`.
+   `llvm` by default.
----------------
`llvm` should be on this line. See other similar descriptions.

================
Comment at: docs/clang-tidy/checks/performance-inefficient-string-concatenation.rst:57
@@ +56,2 @@
+   When zero, the check will only check the string usage in ``while``, ``for``
+   and ``for-range`` statements. 0 by default.
----------------
Please highlight 0 with `.

================
Comment at: docs/clang-tidy/checks/readability-implicit-bool-cast.rst:106
@@ +105,3 @@
+
+   When non-zero, the check will allow conditional integer casts.
+   `0` by default.
----------------
Looks like `0` by should fit 80 characters. Same below.


https://reviews.llvm.org/D23918