
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.
33 lines
766 B
Plaintext
33 lines
766 B
Plaintext
== Why is this an issue?
|
|
|
|
A subroutine that grows too large tends to aggregate too many responsibilities. Such subroutine inevitably become harder to understand and therefore harder to maintain. Above a specific threshold, it is strongly advised to refactor into smaller subroutines which focus on well-defined tasks. Those smaller subroutines will not only be easier to understand, but also probably easier to test.
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.max
|
|
****
|
|
|
|
----
|
|
300
|
|
----
|
|
|
|
Maximum authorized lines in a subroutine
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|