Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-22 05:40:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Update rule documentation to explain how consistent is implemented (fixes #1346).

Browse source
This commit is contained in:
David Anson 2024-10-07 22:08:16 -07:00
parent 61a9c2427e
commit 5faa6f4235
17 changed files with 75 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/md049.md
View file

@ -26,10 +26,11 @@ To fix this issue, use the configured emphasis style throughout the document:
*Text*
```
The configured emphasis style can be a specific symbol to use ("asterisk",
"underscore"), or can require that usage be consistent within the document.
The configured emphasis style can be a specific symbol to use (`asterisk`,
`underscore`) or can require all emphasis matches the first emphasis
(`consistent`).
Note: Emphasis within a word is restricted to "asterisk" in order to avoid
Note: Emphasis within a word is restricted to `asterisk` in order to avoid
unwanted emphasis for words containing internal underscores like_this_one.
Rationale: Consistent formatting makes it easier to understand a document.