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
720 B
Plaintext
51 lines
720 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description-dotnet.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,vbnet]
|
|
----
|
|
Public Class Car
|
|
|
|
<Obsolete> ' Noncompliant
|
|
Public Sub CrankEngine(Turns As Integer)
|
|
' ...
|
|
End Sub
|
|
|
|
End Class
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,vbnet]
|
|
----
|
|
Public Class Car
|
|
|
|
<Obsolete("Replaced by the automatic starter")>
|
|
Public Sub CrankEngine(Turns As Integer)
|
|
' ...
|
|
End Sub
|
|
|
|
End Class
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Add an explanation.
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|