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.
86 lines
1.3 KiB
Plaintext
86 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
Case 1, the code is syntactically correct but the behavior is not the expected one
|
|
|
|
[source,javascript]
|
|
----
|
|
switch (day) {
|
|
case MONDAY:
|
|
case TUESDAY:
|
|
WEDNESDAY: // instead of "case WEDNESDAY"
|
|
doSomething();
|
|
break;
|
|
...
|
|
}
|
|
----
|
|
|
|
Case 2, the code is correct and behaves as expected but is hardly readable
|
|
|
|
|
|
[source,javascript]
|
|
----
|
|
switch (day) {
|
|
case MONDAY:
|
|
break;
|
|
case TUESDAY:
|
|
foo:for(i = 0 ; i < X ; i++) {
|
|
/* ... */
|
|
break foo; // this break statement doesn't relate to the nesting case TUESDAY
|
|
/* ... */
|
|
}
|
|
break;
|
|
/* ... */
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
Case 1
|
|
|
|
[source,javascript]
|
|
----
|
|
switch (day) {
|
|
case MONDAY:
|
|
case TUESDAY:
|
|
case WEDNESDAY:
|
|
doSomething();
|
|
break;
|
|
...
|
|
}
|
|
----
|
|
|
|
Case 2
|
|
|
|
[source,javascript]
|
|
----
|
|
switch (day) {
|
|
case MONDAY:
|
|
break;
|
|
case TUESDAY:
|
|
compute(args); // put the content of the labelled "for" statement in a dedicated method
|
|
break;
|
|
|
|
/* ... */
|
|
}
|
|
----
|
|
|
|
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[]
|