From a86998bf6fac174a6ca61a4b83f5c4e5fcd49e13 Mon Sep 17 00:00:00 2001 From: David Anson Date: Thu, 8 Dec 2022 22:07:10 -0800 Subject: [PATCH] Update documentation for MD038/no-space-in-code to expand rationale (fixes #641). --- doc-build/md038.md | 8 +++++--- doc/Rules.md | 8 +++++--- doc/md038.md | 8 +++++--- 3 files changed, 15 insertions(+), 9 deletions(-) diff --git a/doc-build/md038.md b/doc-build/md038.md index c5abf322..103ed1af 100644 --- a/doc-build/md038.md +++ b/doc-build/md038.md @@ -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 -automatically trimmed (to allow for embedded backticks): +automatically trimmed (in order to allow for code spans that embed backticks): ```markdown `` `backticks` `` ``` 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 `` ` 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. diff --git a/doc/Rules.md b/doc/Rules.md index 43bfcf70..d48a3385 100644 --- a/doc/Rules.md +++ b/doc/Rules.md @@ -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 -automatically trimmed (to allow for embedded backticks): +automatically trimmed (in order to allow for code spans that embed backticks): ```markdown `` `backticks` `` ``` 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 `` ` 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. diff --git a/doc/md038.md b/doc/md038.md index 22c3bb6f..490e990f 100644 --- a/doc/md038.md +++ b/doc/md038.md @@ -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 -automatically trimmed (to allow for embedded backticks): +automatically trimmed (in order to allow for code spans that embed backticks): ```markdown `` `backticks` `` ``` 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 `` ` 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.