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.
51 lines
697 B
Plaintext
51 lines
697 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,swift]
|
|
----
|
|
func doSomething(a: Int, b: Int) { // "b" is unused
|
|
compute(a)
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,swift]
|
|
----
|
|
void doSomething(a: Int) {
|
|
compute(a)
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
Override methods are excluded.
|
|
|
|
|
|
[source,swift]
|
|
----
|
|
override doSomething(a: Int, b: Int) { // no issue reported on b
|
|
compute(a)
|
|
}
|
|
----
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|