Skip to content

Commit

Permalink
mdl: Don't enforce one space after list markers
Browse files Browse the repository at this point in the history
Common markdown styles usually show 4-column indents to separate the
list marker and the list item text.  That's a common template for
writing new markdown files.

On the other hand, we do have some files (such as CHANGES.md) where we
use a different style.

From a markdown perspective, both are perfectly OK, and there's no
reason to enforce either.

Therefore, the best thing is to exclude this particular rule.

Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #18297)

(cherry picked from commit 2046f80)
  • Loading branch information
levitte committed May 19, 2022
1 parent 3667043 commit fa229d4
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions util/markdownlint.rb
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@
exclude_rule 'MD025' # Multiple top level headers in the same document
exclude_rule 'MD026' # Trailing punctuation in header
exclude_rule 'MD029' # Ordered list item prefix
exclude_rule 'MD030' # Spaces after list markers (default: 1!)

0 comments on commit fa229d4

Please sign in to comment.