rspec/rules/S2681/description.adoc
Fred Tingaud 025936fdfb
Modify Rule S2681: LaYC comment blocks
Co-authored-by: Amélie Renard <44666826+amelie-renard-sonarsource@users.noreply.github.com>
2023-06-16 16:55:05 +02:00

10 lines
645 B
Plaintext

Having inconsistent indentation and omitting curly braces from a control structure, such as an `if` statement or `for` loop, is misleading and can induce bugs.
This rule raises an issue when the indentation of the lines after a control structure indicates an intent to include those lines in the block, but the omission of curly braces means the lines will be unconditionally executed once.
The following patterns are recognized:
include::{example}[]
Note that this rule considers tab characters to be equivalent to 1 space. When mixing spaces and tabs, a code may look fine in one editor but be confusing in another configured differently.