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.
39 lines
794 B
Plaintext
39 lines
794 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
include::../noncompliant.adoc[]
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
static final int BEST_NUMBER = 12;
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
The following types of method are ignored:
|
|
|
|
* methods that override a method.
|
|
* methods that are not final (not having the ``++final++``, ``++private++`` or ``++static++`` modifier and not in a record or a final class).
|
|
* methods with annotations, such as ``++@Override++`` or Spring's ``++@RequestMapping++``.
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|