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.
36 lines
795 B
Plaintext
36 lines
795 B
Plaintext
== Why is this an issue?
|
|
|
|
A sub or function that grows too large tends to aggregate too many responsibilities. Such sub or function inevitably become harder to understand and therefore harder to maintain.
|
|
|
|
|
|
Above a specific threshold, it is strongly advised to refactor into smaller subs or functions which focus on well-defined tasks. Those smaller subs or functions 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
|
|
****
|
|
|
|
----
|
|
100
|
|
----
|
|
|
|
Maximum authorized lines in a sub or function
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|