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

[Alexander Kornienko via cfe-commits]

alexfh requested changes to this revision.
This revision now requires changes to proceed.

================
Comment at: docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst:11
@@ -10,3 +10,3 @@
 
-The check can generate fixes after the option `GslHeader` has been set
+The check can generate fixes after the :option:`GslHeader` has been set
 to the name of the include file that contains ``gsl::at()``, e.g. `"gsl/gsl.h"`.
----------------
I don't see the rest of the file (upload full diffs, btw), but we need to add `.. option:: GslHeader`, if it's not there yet. And I think, the general rule should be to add option description in every check that uses the option, since different checks can use the same global option in a subtly different ways.

I hope, Sphinx supports this use case.


Repository:
  rL LLVM

https://reviews.llvm.org/D23728