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.
36 lines
655 B
Plaintext
36 lines
655 B
Plaintext
== Why is this an issue?
|
|
|
|
Nested comments are confusing and can lead maintainers to misunderstand which code is active.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,swift]
|
|
----
|
|
/*
|
|
This is a comment block.
|
|
It may be difficult to figure out that the following line of code is actually commented
|
|
|
|
|
|
variable = function_call();
|
|
/* variable contains the result. Noncompliant; inner comment */
|
|
*/
|
|
----
|
|
|
|
|
|
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[]
|