[PATCH] D92652: [clang-tidy][docs] Update check options with boolean values instead of non-zero/0/1

[Aaron Ballman via Phabricator via cfe-commits]

aaron.ballman added inline comments.


================
Comment at: clang-tools-extra/docs/clang-tidy/checks/bugprone-not-null-terminated-result.rst:60
 - If copy to the destination array can overflow [1] and
-  ``AreSafeFunctionsAvailable`` is set to ``Yes``, ``y`` or non-zero and it is
+  ``AreSafeFunctionsAvailable`` is set to `true` and it is
   possible to obtain the capacity of the destination array then the new function
----------------
This edit loses information about also accepting `Yes` and `y` -- is that intentional (or were those unsupported before)?

FWIW, I'd be fine dropping support for alternate spellings of `true`.


================
Comment at: clang-tools-extra/docs/clang-tidy/checks/bugprone-not-null-terminated-result.rst:130
 
-   An integer non-zero value specifying if the target environment is considered
+   An integer `true` value specifying if the target environment is considered
    to implement '_s' suffixed memory and string handler functions which are
----------------
"An integer true value" is a bit of a strange beast. How about "The value true specifies that the target environment..."?


================
Comment at: clang-tools-extra/docs/clang-tidy/checks/misc-throw-by-value-catch-by-reference.rst:50
+   warning. Only applicable if :option:`WarnOnLargeObject` is set to `true`. If 
+   option is set by the user to `std::numeric_limits<uint64_t>::max()` then it 
+   reverts to the default value.
----------------
Drive-by since we're changing this line already: If option is set -> If the option is set


================
Comment at: clang-tools-extra/docs/clang-tidy/checks/modernize-use-auto.rst:186
    Spaces between multi-lexeme type names (``long int``) are considered as one.
-   If ``RemoveStars`` option (see below) is set to non-zero, then ``*s`` in
+   If :option:`RemoveStars` option (see below) is set to `true`, then ``*s`` in
    the type are also counted as a part of the type name.
----------------
Drive-by since we're already changing the line: If option -> If the option


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D92652/new/

https://reviews.llvm.org/D92652