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.
69 lines
1.0 KiB
Plaintext
69 lines
1.0 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,go]
|
|
----
|
|
func example(condition1, condition2 bool) {
|
|
if condition1 {
|
|
} else if condition1 { // Noncompliant
|
|
}
|
|
}
|
|
----
|
|
|
|
[source,go]
|
|
----
|
|
func SwitchWithMultipleConditions(param int) {
|
|
switch param {
|
|
case 1, 2, 3:
|
|
fmt.Println(">1")
|
|
case 3, 4, 5: // Noncompliant; 3 is duplicated
|
|
fmt.Println("<1")
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,go]
|
|
----
|
|
func example(condition1, condition2 bool) {
|
|
if condition1 {
|
|
} else if condition2 { // Compliant
|
|
}
|
|
}
|
|
----
|
|
|
|
[source,go]
|
|
----
|
|
func SwitchWithMultipleConditions(param int) {
|
|
switch param {
|
|
case 1, 2, 3:
|
|
fmt.Println(">1")
|
|
case 4, 5: // Compliant
|
|
fmt.Println("<1")
|
|
}
|
|
}
|
|
----
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|