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.
48 lines
839 B
Plaintext
48 lines
839 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
public long computeDurationInMilliseconds() {
|
|
long duration = (((hours * 60) + minutes) * 60 + seconds ) * 1000 ;
|
|
return duration;
|
|
}
|
|
|
|
public void doSomething() {
|
|
RuntimeException myException = new RuntimeException();
|
|
throw myException;
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
public long computeDurationInMilliseconds() {
|
|
return (((hours * 60) + minutes) * 60 + seconds ) * 1000 ;
|
|
}
|
|
|
|
public void doSomething() {
|
|
throw new RuntimeException();
|
|
}
|
|
----
|
|
|
|
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[]
|