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.
60 lines
903 B
Plaintext
60 lines
903 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
The following code snippet illustrates this rule with the default threshold of 5:
|
|
|
|
[source,swift]
|
|
----
|
|
switch myVariable {
|
|
case 0: // 6 lines till next case
|
|
methodCall1("")
|
|
methodCall2("")
|
|
methodCall3("")
|
|
methodCall4("")
|
|
methodCall5("")
|
|
case 1:
|
|
...
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,swift]
|
|
----
|
|
switch myVariable {
|
|
case 0:
|
|
doSomething()
|
|
case 1:
|
|
...
|
|
}
|
|
...
|
|
func doSomething(){
|
|
methodCall1("")
|
|
methodCall2("")
|
|
methodCall3("")
|
|
methodCall4("")
|
|
methodCall5("")
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../parameters.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|