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.
58 lines
1.2 KiB
Plaintext
58 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Jump statements, such as ``++return++``, ``++break++`` and ``++continue++`` let you change the default flow of program execution, but jump statements that direct the control flow to the original direction are just a waste of keystrokes.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,python]
|
|
----
|
|
def redundant_jump(x):
|
|
if x == 1:
|
|
print(True)
|
|
return # NonCompliant
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,python]
|
|
----
|
|
def redundant_jump(x):
|
|
if x == 1:
|
|
print(True)
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
* No issue is raised if the jump statement is the only statement of a statement suite:
|
|
|
|
[source,python]
|
|
----
|
|
def my_function(x):
|
|
if x > 5:
|
|
do_something()
|
|
elif x == 0:
|
|
return # ok even it could be changed to "pass"
|
|
else:
|
|
do_something_else()
|
|
----
|
|
|
|
* No issue is raised for ``++return None++`` because this was certainly done on purpose to be explicit that a function is really returning ``++None++``.
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|