rspec/rules/S1300/cobol/rule.adoc

== Why is this an issue?

A section that grows too large tends to aggregate too many responsibilities.

Such sections inevitably become harder to understand and therefore harder to maintain.

Above a specific threshold, it is strongly advised to refactor into smaller sections which focus on well-defined tasks. Those smaller sections 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)

=== Message

Section has {0, number} lines of code instead of {1, number} authorized.


=== Parameters

.maximumLinesThreshold
****

----
100
----

The maximum number of lines of code allowed in a section.
****


'''
== Comments And Links
(visible only on this page)

=== is related to: S1287

=== on 29 May 2015, 13:05:52 Ann Campbell wrote:
double-check me, [~pierre-yves.nicolas]

=== on 29 May 2015, 15:45:55 Pierre-Yves Nicolas wrote:
I changed the SQALE factor to 2min per line.

endif::env-github,rspecator-view[]
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`== Why is this an issue?`

Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			`A section that grows too large tends to aggregate too many responsibilities.`

			`Such sections inevitably become harder to understand and therefore harder to maintain.`

			`Above a specific threshold, it is strongly advised to refactor into smaller sections which focus on well-defined tasks. Those smaller sections will not only be easier to understand, but also probably easier to test.`
Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00
Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`ifdef::env-github,rspecator-view[]`
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
			`'''`
			`== Implementation Specification`
			`(visible only on this page)`

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			`=== Message`

			`Section has {0, number} lines of code instead of {1, number} authorized.`


			`=== Parameters`

			`.maximumLinesThreshold`
			`****`

			`----`
			`100`
			`----`

			`The maximum number of lines of code allowed in a section.`
			`****`
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00

RULEAPI-576: add a horizontal rule between rule description and comments 2021-06-08 15:52:13 +02:00			`'''`
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00			`== Comments And Links`
			`(visible only on this page)`

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			`=== is related to: S1287`

			`=== on 29 May 2015, 13:05:52 Ann Campbell wrote:`
			`double-check me, [~pierre-yves.nicolas]`

			`=== on 29 May 2015, 15:45:55 Pierre-Yves Nicolas wrote:`
			`I changed the SQALE factor to 2min per line.`

Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`endif::env-github,rspecator-view[]`