
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.
72 lines
882 B
Plaintext
72 lines
882 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
With a threshold of 5:
|
|
|
|
[source,php]
|
|
----
|
|
switch ($var) {
|
|
case 0: // 6 lines till next case
|
|
methodCall1();
|
|
methodCall2();
|
|
methodCall3();
|
|
methodCall4();
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,php]
|
|
----
|
|
switch ($var) {
|
|
case 0:
|
|
doSomething();
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
function doSomething(){
|
|
methodCall1("");
|
|
methodCall2("");
|
|
methodCall3("");
|
|
methodCall4("");
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.max
|
|
****
|
|
_Integer_
|
|
|
|
----
|
|
10
|
|
----
|
|
|
|
Maximum number of lines of code
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|