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 documentation for MD038/no-space-in-code to expand rationale (fixes #641).

Browse source
This commit is contained in:
David Anson 2022-12-08 22:07:10 -08:00
parent 5eef37751b
commit a86998bf6f
3 changed files with 15 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc-build/md038.md
View file

@ -14,17 +14,19 @@ To fix this, remove any spaces adjacent to the backticks:
``` ```
Note: A single leading and trailing space is allowed by the specification and Note: A single leading and trailing space is allowed by the specification and
automatically trimmed (to allow for embedded backticks): automatically trimmed (in order to allow for code spans that embed backticks):
```markdown ```markdown
`` `backticks` `` `` `backticks` ``
``` ```
Note: A single leading or trailing space is allowed if used to separate code Note: A single leading or trailing space is allowed if used to separate code
span markers from an embedded backtick: span markers from an embedded backtick (though the space is not trimmed):
```markdown ```markdown
`` ` embedded backtick`` `` ` embedded backtick``
``` ```
Rationale: Violations of this rule can lead to improperly rendered content. Rationale: Violations of this rule are usually unintentional and may lead to
improperly-rendered content. If spaces beside backticks are intentional, this
rule can be disabled for that line or file.

8
doc/Rules.md
View file

@ -1597,20 +1597,22 @@ To fix this, remove any spaces adjacent to the backticks:
``` ```
Note: A single leading and trailing space is allowed by the specification and Note: A single leading and trailing space is allowed by the specification and
automatically trimmed (to allow for embedded backticks): automatically trimmed (in order to allow for code spans that embed backticks):
```markdown ```markdown
`` `backticks` `` `` `backticks` ``
``` ```
Note: A single leading or trailing space is allowed if used to separate code Note: A single leading or trailing space is allowed if used to separate code
span markers from an embedded backtick: span markers from an embedded backtick (though the space is not trimmed):
```markdown ```markdown
`` ` embedded backtick`` `` ` embedded backtick``
``` ```
Rationale: Violations of this rule can lead to improperly rendered content. Rationale: Violations of this rule are usually unintentional and may lead to
improperly-rendered content. If spaces beside backticks are intentional, this
rule can be disabled for that line or file.
<a name="md039"></a> <a name="md039"></a>

8
doc/md038.md
View file

@ -22,17 +22,19 @@ To fix this, remove any spaces adjacent to the backticks:
``` ```
Note: A single leading and trailing space is allowed by the specification and Note: A single leading and trailing space is allowed by the specification and
automatically trimmed (to allow for embedded backticks): automatically trimmed (in order to allow for code spans that embed backticks):
```markdown ```markdown
`` `backticks` `` `` `backticks` ``
``` ```
Note: A single leading or trailing space is allowed if used to separate code Note: A single leading or trailing space is allowed if used to separate code
span markers from an embedded backtick: span markers from an embedded backtick (though the space is not trimmed):
```markdown ```markdown
`` ` embedded backtick`` `` ` embedded backtick``
``` ```
Rationale: Violations of this rule can lead to improperly rendered content. Rationale: Violations of this rule are usually unintentional and may lead to
improperly-rendered content. If spaces beside backticks are intentional, this
rule can be disabled for that line or file.