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.
33 lines
725 B
Plaintext
33 lines
725 B
Plaintext
== Why is this an issue?
|
|
|
|
There is no good excuse for an empty class. If it's being used simply as a common extension point, it should be replaced with a ``++protocol++``. If it was stubbed in as a placeholder for future development it should be fleshed-out. In any other case, it should be eliminated.
|
|
|
|
include::../noncompliant.adoc[]
|
|
|
|
=== Compliant solution
|
|
|
|
[source,swift]
|
|
----
|
|
public protocol Nothing {
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Remove this empty class, write its code or make it a "protocol".
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|