Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 22:10:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Allow question mark by default for MD026/no-trailing-punctuation (fixes #276).

Browse source
This commit is contained in:
David Anson 2020-11-17 20:32:17 -08:00
parent 3827842930
commit 6c1bc8ecb5
8 changed files with 30 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/Rules.md
View file

@ -895,7 +895,7 @@ Tags: headings, headers
Aliases: no-trailing-punctuation
Parameters: punctuation (string; default ".,;:!?。，；：！？")
Parameters: punctuation (string; default ".,;:!。，；：！")
Fixable: Most violations can be fixed by tooling
@ -914,7 +914,8 @@ To fix this, remove the trailing punctuation:
Note: The `punctuation` parameter can be used to specify what characters count
as punctuation at the end of a heading. For example, you can change it to
`".,;:!"` to allow headings that end with a question mark, such as in an FAQ.
`".,;:"` to allow headings that end with an exclamation point. Question mark is
allowed by default because of how common it is in headings of FAQ-style documents.
Setting the `punctuation` parameter to `""` allows all characters - and is
equivalent to disabling the rule.