rspec/rules/S1625/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

38 lines
844 B
Plaintext

== Why is this an issue?
A results indicator should be used on a ``++CHAIN++`` statement because it leads to cleaner, more readable, and more correct code. Using an indicator results in the conditions ``++record not found++``, and ``++end of file++`` being automatically handled correctly, without the need for further error handling.
=== Noncompliant code example
[source,rpg]
----
C K0GMCP CHAIN SSGMCPR
----
=== Compliant solution
[source,rpg]
----
C K0GMCP CHAIN SSGMCPR 81
----
=== Exceptions
Free-form ``++CHAIN++`` statements cannot have indicators, and are ignored.
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Add an indicator to this ``++CHAIN++`` statement
endif::env-github,rspecator-view[]