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.
48 lines
791 B
Plaintext
48 lines
791 B
Plaintext
== Why is this an issue?
|
|
|
|
The requirement for a final ``++else++`` clause is defensive programming. The clause should either take appropriate action, or contain a suitable comment as to why no action is taken.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,ruby]
|
|
----
|
|
case param
|
|
when 1
|
|
do_something()
|
|
when 2
|
|
do_something_else()
|
|
end
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,ruby]
|
|
----
|
|
case param
|
|
when 1
|
|
do_something()
|
|
when 2
|
|
do_something_else()
|
|
else
|
|
handle_error('error_message')
|
|
end
|
|
----
|
|
|
|
include::../see.adoc[]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|