rspec/rules/S2757/python/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
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.
2023-06-22 10:38:01 +02:00

51 lines
1.1 KiB
Plaintext

== Why is this an issue?
Using operator pairs (``++=+++`` or ``++=-++``) that look like reversed single operators (``+++=++`` or ``++-=++``) is confusing. They compile and run but do not produce the same result as their mirrored counterpart.
[source,python]
----
target = -5
num = 3
target =- num # Noncompliant: target = -3. Is that really what's meant?
target =+ num # Noncompliant: target = 3
----
This rule raises an issue when ``++=+++`` or ``++=-++`` are used without any space between the operators and when there is at least one whitespace after.
Replace the operators with a single one if that is the intention
[source,python]
----
target = -5
num = 3
target -= num # target = -8
----
Or fix the spacing to avoid confusion
[source,python]
----
target = -5
num = 3
target = -num # target = -3
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]