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.
74 lines
1010 B
Plaintext
74 lines
1010 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
public void doTheThing() {
|
|
try {
|
|
// ...
|
|
catch (IOException e) { // Noncompliant
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
public void doTheThing() throws IOException {
|
|
// ...
|
|
}
|
|
----
|
|
or
|
|
|
|
[source,java]
|
|
----
|
|
public void doTheThing() {
|
|
try {
|
|
// ...
|
|
catch (IOException e) {
|
|
LOGGER.info(e);
|
|
}
|
|
}
|
|
----
|
|
or
|
|
|
|
[source,java]
|
|
----
|
|
public void doTheThing() {
|
|
try {
|
|
// ...
|
|
catch (IOException e) {
|
|
// comment explaining why taking no action is appropriate
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
When a block contains a comment, it is not considered to be empty.
|
|
|
|
include::../see.adoc[]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Handle this exception or don't catch it at all.
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|