Skip to content

Commit

Permalink
Add parameter (value and default) information to rule documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidAnson committed Mar 19, 2015
1 parent c6bbebf commit 66f84a3
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/RULES.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The first header in the document should be a h1 header:

Tags: headers

Parameters: style
Parameters: style ("consistent", "atx", "atx_closed", "setext"; default "consistent")

This rule is triggered when different header styles (atx, setext, and 'closed'
atx) are used in the same document:
Expand All @@ -79,7 +79,7 @@ document.

Tags: bullet, ul

Parameters: style
Parameters: style ("consistent", "asterisk", "plus", "dash"; default "consistent")

This rule is triggered when the symbols used in the document for unordered
list items do not match the configured unordered list style:
Expand Down Expand Up @@ -149,7 +149,7 @@ characters if you use 4 space tabs, or 1 character if you use 2 space tabs).

Tags: bullet, ul, indentation

Parameters: indent
Parameters: indent (number; default 2)

This rule is triggered when list items are not indented by the configured
number of spaces (default: 2).
Expand Down Expand Up @@ -244,7 +244,7 @@ lines inside code blocks.

Tags: line_length

Parameters: line_length
Parameters: line_length (number; default 80)

This rule is triggered when there are lines that are longer than the
configured line length (default: 80 characters). To fix this, split the line
Expand Down Expand Up @@ -463,7 +463,7 @@ should be contained within this header.

Tags: headers

Parameters: punctuation
Parameters: punctuation (string; default ".,;:!?")

This rule is triggered on any header that has a punctuation character as the
last character in the line:
Expand Down Expand Up @@ -531,7 +531,7 @@ separate blockquotes.

Tags: ol

Parameters: style
Parameters: style ("one", "ordered"; default "one")

This rule is triggered on ordered lists that do not either start with '1.' or
do not have a prefix that increases in numerical order (depending on the
Expand All @@ -553,7 +553,7 @@ Example valid list if the style is configured as 'ordered':

Tags: ol, ul, whitespace

Parameters: ul_single, ol_single, ul_multi, ol_multi
Parameters: ul_single, ol_single, ul_multi, ol_multi (number, default 1)

This rule checks for the number of spaces between a list marker (e.g. '`-`',
'`*`', '`+`' or '`1.`') and the text of the list item.
Expand Down

0 comments on commit 66f84a3

Please sign in to comment.