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.
45 lines
613 B
Plaintext
45 lines
613 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,flex]
|
|
----
|
|
function func1() { // Noncompliant - there are two points of exit
|
|
if (false) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
function func2() { // Noncompliant - there are two points of exit
|
|
if (a > 0) {
|
|
return 0;
|
|
}
|
|
return -1;
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,flex]
|
|
----
|
|
function func1() {
|
|
return;
|
|
}
|
|
|
|
function func2() {
|
|
}
|
|
|
|
function func3();
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|