rspec/rules/S2486/rpg/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
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.
2023-05-25 14:18:12 +02:00

53 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[]