Skip to content

Commit 284fa1b

Browse files
committed
add options to doc
1 parent 0b59b37 commit 284fa1b

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

clang-tools-extra/docs/clang-tidy/checks/modernize/use-std-numbers.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,19 @@ where appropriate.
5656
floatSink(MY_PI); // floatSink(std::numbers::pi);
5757
floatSink(static_cast<float>(MY_PI)); // floatSink(std::numbers::pi_v<float>);
5858
}
59+
60+
Options
61+
-------
62+
63+
.. option:: DiffThreshold
64+
65+
A floating point value that sets the detection threshold for when literals
66+
match a constant.
67+
A literal matches a constant if
68+
``abs(literal - constant) < DiffThreshold`` evaluates to true.
69+
Default is `0.001`.
70+
71+
.. option:: IncludeStyle
72+
73+
A string specifying which include-style is used, `llvm` or `google`. Default
74+
is `llvm`.

0 commit comments

Comments
 (0)