51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
56 lines
1.0 KiB
Plaintext
56 lines
1.0 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Having all branches of an `if` chain with the same implementation indicates a problem.
|
|
|
|
In the following code:
|
|
|
|
[source,python]
|
|
----
|
|
if b == 0: # Noncompliant
|
|
doOneMoreThing()
|
|
elif b == 1:
|
|
doOneMoreThing()
|
|
else:
|
|
doOneMoreThing()
|
|
|
|
b = 4 if a > 12 else 4 # Noncompliant
|
|
----
|
|
|
|
Either there is a copy-paste error that needs fixing or the unnecessary `if` chain needs removing.
|
|
|
|
=== Exceptions
|
|
|
|
This rule does not apply to `if` chains without `else`.
|
|
|
|
|
|
[source,python]
|
|
----
|
|
if b == 0: # no issue, this could have been done on purpose to make the code more readable
|
|
doOneMoreThing()
|
|
elif b == 1:
|
|
doOneMoreThing()
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Highlighting
|
|
|
|
primary: the top "if" keyword
|
|
|
|
secondary: each identical body of the "if-elif-else"
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|