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.
53 lines
864 B
Plaintext
53 lines
864 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,python]
|
|
----
|
|
import hashlib
|
|
m = hashlib.md5() // Noncompliant
|
|
----
|
|
|
|
[source,python]
|
|
----
|
|
import hashlib
|
|
m = hashlib.sha1() // Noncompliant
|
|
----
|
|
|
|
[source,python]
|
|
----
|
|
import md5 // Noncompliant and deprecated since Python 2.5; use the hashlib module instead.
|
|
m = md5.new()
|
|
|
|
import sha // Noncompliant and deprecated since Python 2.5; use the hashlib module instead.
|
|
m = sha.new()
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,python]
|
|
----
|
|
import hashlib
|
|
m = hashlib.sha256() // Compliant
|
|
----
|
|
|
|
include::../see.adoc[]
|
|
|
|
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[]
|