[PATCH] D23728: [Clang-tidy] Fix style in some checks documentation

Alexander Kornienko via cfe-commits cfe-commits at lists.llvm.org
Mon Aug 22 15:08:41 PDT 2016


alexfh accepted this revision.
alexfh added a comment.
This revision is now accepted and ready to land.

LG with a few nits.


================
Comment at: docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst:9
@@ -8,3 +8,3 @@
 are out of bounds (for ``std::array``). For out-of-bounds checking of static
-arrays, see the clang-diagnostic-array-bounds check.
+arrays, see the `clang-diagnostic-array-bounds` check.
 
----------------
Can we make this a link?

================
Comment at: docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst:19
@@ +18,3 @@
+
+   The check can generate fixes after the this option has been set to the name
+   of the include file that contains ``gsl::at()``, e.g. `"gsl/gsl.h"`.
----------------
nit: "the this" - one of these should go

================
Comment at: docs/clang-tidy/checks/misc-misplaced-widening-cast.rst:19
@@ -16,4 +18,3 @@
 
-The result x*1000 is first calculated using int precision. If the result
-exceeds int precision there is loss of precision. Then the result is casted to
-long.
+The result `x * 1000` is first calculated using ``int`` precision. If the result
+exceeds ``int`` precision there is loss of precision. Then the result is casted
----------------
`x * 1000` should also be enclosed in double quotes, imo.

================
Comment at: docs/clang-tidy/checks/misc-misplaced-widening-cast.rst:65
@@ +64,2 @@
+
+   Enable (default) or disable detection of implicit casts.
----------------
I'd say "If non-zero, enables detection of implicit casts. Default is non-zero."


Repository:
  rL LLVM

https://reviews.llvm.org/D23728





More information about the cfe-commits mailing list