Skip to content

Commit 7c07e2c

Browse files
committed
Add comments to the style-rules-prod file
1 parent 4707211 commit 7c07e2c

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

Diff for: _checks/styles/style-rules-prod

+21-21
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
1-
rule 'MD001'
1+
rule 'MD001' # Header levels should only increment by one level at a time
22
exclude_rule 'MD002'
3-
rule 'MD003', :style => :atx
4-
rule 'MD004'
5-
rule 'MD005'
6-
rule 'MD006'
7-
rule 'MD007', :indent => 3
8-
rule 'MD009'
9-
rule 'MD010'
3+
rule 'MD003', :style => :atx # Header style
4+
rule 'MD004' # Unordered list style; default "consistent"
5+
rule 'MD005' # Inconsistent indentation for list items at the same level
6+
rule 'MD006' # Consider starting bulleted lists at the beginning of the line
7+
rule 'MD007', :indent => 3 # Unordered list indentation
8+
rule 'MD009' # Trailing spaces; default: 0
9+
rule 'MD010' # Hard tabs
1010
exclude_rule 'MD011'
11-
rule 'MD012'
11+
rule 'MD012' # Multiple consecutive blank lines
1212
exclude_rule 'MD013'
1313
exclude_rule 'MD014'
14-
rule 'MD018'
15-
rule 'MD019'
14+
rule 'MD018' # No space after hash on atx style header
15+
rule 'MD019' # Multiple spaces after hash on atx style header
1616
exclude_rule 'MD020'
1717
exclude_rule 'MD021'
1818
exclude_rule 'MD022'
19-
rule 'MD023'
19+
rule 'MD023' # Headers must start at the beginning of the line
2020
exclude_rule 'MD024'
21-
rule 'MD025'
21+
rule 'MD025' # Multiple top level headers in the same document
2222
exclude_rule 'MD026'
2323
exclude_rule 'MD027'
2424
exclude_rule 'MD028'
25-
rule 'MD029'
26-
rule 'MD030', :ul_single => 2, :ol_single => 1, :ul_multi => 2, :ol_multi => 1
25+
rule 'MD029' # Ordered list item prefix
26+
rule 'MD030', :ul_single => 2, :ol_single => 1, :ul_multi => 2, :ol_multi => 1 # Spaces after list markers
2727
exclude_rule 'MD031'
28-
rule 'MD032'
28+
rule 'MD032' # Lists should be surrounded by blank lines
2929
exclude_rule 'MD033'
3030
exclude_rule 'MD034'
31-
rule 'MD035'
32-
rule 'MD036'
33-
rule 'MD037'
34-
rule 'MD038'
31+
rule 'MD035' # Horizontal rule style; default "consistent"
32+
rule 'MD036' # Emphasis used instead of a header
33+
rule 'MD037' # Spaces inside emphasis markers
34+
rule 'MD038' # Spaces inside code span elements
3535
exclude_rule 'MD039'
36-
rule 'MD040'
36+
rule 'MD040' # Fenced code blocks should have a language specified
3737
exclude_rule 'MD041'
3838
exclude_rule 'MD046'

0 commit comments

Comments
 (0)