
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
614 B
Plaintext
39 lines
614 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,apex]
|
|
----
|
|
public Integer numberOfMinutes(Integer hours) {
|
|
Integer seconds = 0; // seconds is never used
|
|
return hours * 60;
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,apex]
|
|
----
|
|
public Integer numberOfMinutes(Integer hours) {
|
|
return hours * 60;
|
|
}
|
|
----
|
|
|
|
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[]
|