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.
54 lines
865 B
Plaintext
54 lines
865 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,python]
|
|
----
|
|
def hello(name):
|
|
message = "Hello " + name # Noncompliant
|
|
print(name)
|
|
for i in range(10):
|
|
foo()
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,python]
|
|
----
|
|
def hello(name):
|
|
message = "Hello " + name
|
|
print(message)
|
|
for _ in range(10):
|
|
foo()
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
``++_++`` will not raise an issue for this rule. The following examples are compliant:
|
|
|
|
[source,python]
|
|
----
|
|
for _ in range(10):
|
|
do_something()
|
|
username, login, _ = auth
|
|
do_something_else(username, login)
|
|
----
|
|
|
|
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[]
|