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.
66 lines
878 B
Plaintext
66 lines
878 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default threshold of 5:
|
|
|
|
[source,go]
|
|
----
|
|
func foo(tag int) {
|
|
switch tag {
|
|
case 0:
|
|
methodCall1()
|
|
methodCall2()
|
|
methodCall3()
|
|
methodCall4()
|
|
methodCall5()
|
|
methodCall6()
|
|
case 1:
|
|
bar()
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,go]
|
|
----
|
|
func foo(tag int) {
|
|
switch tag {
|
|
case 0:
|
|
executeAll()
|
|
case 1:
|
|
bar()
|
|
}
|
|
}
|
|
|
|
func executeAll() {
|
|
methodCall1()
|
|
methodCall2()
|
|
methodCall3()
|
|
methodCall4()
|
|
methodCall5()
|
|
methodCall6()
|
|
}
|
|
----
|
|
|
|
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[]
|