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.
69 lines
910 B
Plaintext
69 lines
910 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
public class Foo {
|
|
private int a;
|
|
private int b;
|
|
|
|
public void doSomething(int y) {
|
|
a = y + 5;
|
|
...
|
|
if(a == 0) {
|
|
...
|
|
}
|
|
...
|
|
}
|
|
|
|
public void doSomethingElse(int y) {
|
|
b = y + 3;
|
|
...
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
public class Foo {
|
|
|
|
public void doSomething(int y) {
|
|
int a = y + 5;
|
|
...
|
|
if(a == 0) {
|
|
...
|
|
}
|
|
}
|
|
|
|
public void doSomethingElse(int y) {
|
|
int b = y + 3;
|
|
...
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
This rule doesn't raise any issue on annotated field.
|
|
|
|
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[]
|