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.
39 lines
807 B
Plaintext
39 lines
807 B
Plaintext
== Why is this an issue?
|
|
|
|
Global variables are a useful construct, but they should not be abused. Functions access the global scope through the ``++global++`` keyword, but this practice considerably reduce the function's readability and reusability. Instead, the global variable should be passed as a parameter to the function.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,python]
|
|
----
|
|
NAME = 'Joe'
|
|
|
|
def write_name();
|
|
global NAME # Noncompliant
|
|
print NAME
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,python]
|
|
----
|
|
def write_name(name);
|
|
print name
|
|
----
|
|
|
|
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[]
|