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.
47 lines
995 B
Plaintext
47 lines
995 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default threshold of 3:
|
|
|
|
[source,javascript]
|
|
----
|
|
if (condition1) { // Compliant - depth = 1
|
|
/* ... */
|
|
if (condition2) { // Compliant - depth = 2
|
|
/* ... */
|
|
for(let i = 0; i < 10; i++) { // Compliant - depth = 3, not exceeding the limit
|
|
/* ... */
|
|
if (condition4) { // Non-Compliant - depth = 4
|
|
if (condition5) { // Depth = 5, exceeding the limit, but issues are only reported on depth = 4
|
|
/* ... */
|
|
}
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../parameters.adoc[]
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|