Skip to content

Commit 981a979

Browse files
committed
C++: Update .qhelp with precision disclaimer.
1 parent 68b4733 commit 981a979

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

cpp/ql/src/Best Practices/Likely Errors/CommaBeforeMisleadingIndentation.qhelp

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,21 @@
66
<overview>
77
<p>
88
If the expression to the right of a comma operator starts at an earlier column than the expression to the left, then
9-
this suspicious indentation likely indicates a logic error caused by a typo that may escape visual inspection.
9+
this suspicious indentation possibly indicates a logic error, caused by a typo that may escape visual inspection.
1010
</p>
11+
<warning>
12+
This query has medium precision because CodeQL currently does not distinguish between tabs and spaces in whitespace.
13+
Alerts may therefore flag code that appears readable for one value of tab size but not another.
14+
</warning>
1115
</overview>
1216

1317
<recommendation>
1418
<p>
1519
Use standard indentation around the comma operator: begin the right-hand-side operand at the same level of
16-
indentation as the left-hand-side operand.
20+
indentation (column number) as the left-hand-side operand.
21+
</p>
22+
<p>
23+
When it comes to whitespace, either do not mix tabs and spaces, or mix them consistently.
1724
</p>
1825
</recommendation>
1926

0 commit comments

Comments
 (0)