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.
63 lines
1.2 KiB
Plaintext
63 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
:func_name: function
|
|
|
|
include::../description.adoc[]
|
|
|
|
[source,python,diff-id=1,diff-type=noncompliant]
|
|
----
|
|
class MyClass:
|
|
code = "secret"
|
|
|
|
def calculate_code(self):
|
|
self.do_the_thing()
|
|
return self.__class__.code
|
|
|
|
def get_name(self): # Noncompliant: duplicates calculate_code
|
|
self.do_the_thing()
|
|
return self.__class__.code
|
|
|
|
def do_the_thing(self):
|
|
pass # on purpose
|
|
----
|
|
|
|
include::../inter.adoc[]
|
|
|
|
[source,python,diff-id=1,diff-type=compliant]
|
|
----
|
|
class MyClass:
|
|
code = "secret"
|
|
|
|
def calculate_code(self):
|
|
self.do_the_thing()
|
|
return self.__class__.code
|
|
|
|
def get_name(self): # Intent is clear
|
|
return self.calculate_code()
|
|
|
|
def do_the_thing(self):
|
|
pass # on purpose
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
No issue will be raised on empty methods/functions and methods/functions with only one line of code.
|
|
|
|
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[]
|