rspec/rules/S1290/cobol/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

34 lines
890 B
Plaintext

== Why is this an issue?
An unused paragraph is never called explicitly with help of the ``++GO TO++`` or ``++PERFORM++`` statements.
There are only two reasons for such a paragraph:
* It is really unused, and should be removed
* It is used as a kind of comment to clearly delimit a block of code, which is bad practice
The remediation action should be:
* Replace the paragraph by a comment line
* Refactor the code to make an explicit call to this paragraph instead of letting the execution flow going through it implicitly
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Either this paragraph "XXXX" is dead code that must be removed or the code must be refactored to make an explicit call to it.
'''
== Comments And Links
(visible only on this page)
=== is related to: S1461
endif::env-github,rspecator-view[]