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.
57 lines
900 B
Plaintext
57 lines
900 B
Plaintext
== Why is this an issue?
|
|
|
|
:func_name: method
|
|
|
|
include::../description.adoc[]
|
|
|
|
[source,apex,diff-id=1,diff-type=noncompliant]
|
|
----
|
|
private String code = 'secret';
|
|
|
|
public String calculateCode() {
|
|
doTheThing();
|
|
return code;
|
|
}
|
|
|
|
public String getName() { // Noncompliant: duplicates calculateCode
|
|
doTheThing();
|
|
return code;
|
|
}
|
|
----
|
|
|
|
include::../inter.adoc[]
|
|
|
|
[source,apex,diff-id=1,diff-type=compliant]
|
|
----
|
|
private String code = 'secret';
|
|
|
|
public String getCode() {
|
|
doTheThing();
|
|
return code;
|
|
}
|
|
|
|
public String getName() { // Intent is clear
|
|
return getCode();
|
|
}
|
|
----
|
|
|
|
include::../exceptions.adoc[]
|
|
|
|
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[]
|