docs(text-escaping): indicate defaults for escapeHTML

gajus · Aug 14, 2024 · b039833 · b039833
1 parent 964712b
commit b039833
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 4 deletions.
diff --git a/.README/rules/no-bad-blocks.md b/.README/rules/no-bad-blocks.md
@@ -6,7 +6,7 @@ This rule checks for multi-line-style comments which fail to meet the
 criteria of a JSDoc block, namely that it should begin with two and only two
 asterisks, but which appear to be intended as JSDoc blocks due to the presence
 of whitespace followed by whitespace or asterisks, and
-an at-sign (`@`) and some non-whitespace (as with a jsdoc block tag).
+an at-sign (`@`) and some non-whitespace (as with a JSDoc block tag).
 
 Exceptions are made for ESLint directive comments (which may use `@` in
 rule names).

diff --git a/.README/rules/text-escaping.md b/.README/rules/text-escaping.md
@@ -19,11 +19,13 @@ within it or your documentation.
 ### `escapeHTML`
 
 This option escapes all `<` and `&` characters (except those followed by
-whitespace which are treated as literals by Visual Studio Code).
+whitespace which are treated as literals by Visual Studio Code). Defaults to
+`false`.
 
 ### `escapeMarkdown`
 
 This option escapes the first backtick (`` ` ``) in a paired sequence.
+Defaults to `false`.
 
 ## Context and settings
 

diff --git a/docs/rules/no-bad-blocks.md b/docs/rules/no-bad-blocks.md
@@ -8,7 +8,7 @@ This rule checks for multi-line-style comments which fail to meet the
 criteria of a JSDoc block, namely that it should begin with two and only two
 asterisks, but which appear to be intended as JSDoc blocks due to the presence
 of whitespace followed by whitespace or asterisks, and
-an at-sign (`@`) and some non-whitespace (as with a jsdoc block tag).
+an at-sign (`@`) and some non-whitespace (as with a JSDoc block tag).
 
 Exceptions are made for ESLint directive comments (which may use `@` in
 rule names).

diff --git a/docs/rules/text-escaping.md b/docs/rules/text-escaping.md
@@ -34,13 +34,15 @@ within it or your documentation.
 ### <code>escapeHTML</code>
 
 This option escapes all `<` and `&` characters (except those followed by
-whitespace which are treated as literals by Visual Studio Code).
+whitespace which are treated as literals by Visual Studio Code). Defaults to
+`false`.
 
 <a name="user-content-text-escaping-options-escapemarkdown"></a>
 <a name="text-escaping-options-escapemarkdown"></a>
 ### <code>escapeMarkdown</code>
 
 This option escapes the first backtick (`` ` ``) in a paired sequence.
+Defaults to `false`.
 
 <a name="user-content-text-escaping-context-and-settings"></a>
 <a name="text-escaping-context-and-settings"></a>