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.
50 lines
905 B
Plaintext
50 lines
905 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
include::../noncompliant.adoc[]
|
|
|
|
include::../compliant.adoc[]
|
|
|
|
=== Exceptions
|
|
|
|
This rule is relaxed in the following cases:
|
|
|
|
|
|
----
|
|
switch (myVariable) {
|
|
case 0: // Empty case used to specify the same behavior for a group of cases.
|
|
case 1:
|
|
doSomething();
|
|
break;
|
|
case 2: // Use of return statement
|
|
return;
|
|
case 3: // Use of throw statement
|
|
throw new IllegalStateException();
|
|
case 4: // Use of continue statement
|
|
continue;
|
|
default: // For the last case, use of break statement is optional
|
|
doSomethingElse();
|
|
}
|
|
----
|
|
|
|
|
|
include::../see.adoc[]
|
|
|
|
|
|
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[]
|