hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-04 13:15:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

C++: Update .qhelp with precision disclaimer.

Browse Source
This commit is contained in:
Nora Dimitrijević
2022-09-29 23:59:22 +02:00
parent 68b473377a
commit 981a9798b8
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
cpp/ql/src/Best Practices/Likely Errors/CommaBeforeMisleadingIndentation.qhelp
View File

@@ -6,14 +6,21 @@
<overview>
<p>
If the expression to the right of a comma operator starts at an earlier column than the expression to the left, then
this suspicious indentation likely indicates a logic error caused by a typo that may escape visual inspection.
this suspicious indentation possibly indicates a logic error, caused by a typo that may escape visual inspection.
</p>
<warning>
This query has medium precision because CodeQL currently does not distinguish between tabs and spaces in whitespace.
Alerts may therefore flag code that appears readable for one value of tab size but not another.
</warning>
</overview>
<recommendation>
<p>
Use standard indentation around the comma operator: begin the right-hand-side operand at the same level of
indentation as the left-hand-side operand.
indentation (column number) as the left-hand-side operand.
</p>
<p>
When it comes to whitespace, either do not mix tabs and spaces, or mix them consistently.
</p>
</recommendation>