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.
54 lines
1.0 KiB
Plaintext
54 lines
1.0 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Leaving an ``++ON-ERROR++`` block empty means that the exception in question is neither handled nor passed forward to callers for handling at a higher level. Suppressing errors rather than handling them could lead to unpredictable system behavior and should be avoided.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,rpg]
|
|
----
|
|
/free
|
|
monitor;
|
|
// ...
|
|
on-error *FILE; // Noncompliant
|
|
endmon;
|
|
/end-free
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,rpg]
|
|
----
|
|
/free
|
|
monitor;
|
|
// ...
|
|
on-error *FILE;
|
|
handleFileError();
|
|
endmon;
|
|
/end-free
|
|
----
|
|
|
|
=== 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
|
|
|
|
Either handle this XXX error or allow it to propagate.
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|