16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
36 lines
542 B
Plaintext
36 lines
542 B
Plaintext
== Why is this an issue?
|
|
|
|
Comments are meant to be human readable. Writing valid sentences is a good way to ensure this is achieved.
|
|
|
|
|
|
Note that XML documentation and trailing comments are not affected by this rule.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,text]
|
|
----
|
|
' tbd
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,text]
|
|
----
|
|
' To be determined.
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Edit this comment into a full sentence
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|