From b039833bfc27b28bfc2663e3a0d9349332a63e45 Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Wed, 14 Aug 2024 22:30:21 +0800 Subject: [PATCH] docs(text-escaping): indicate defaults for `escapeHTML` --- .README/rules/no-bad-blocks.md | 2 +- .README/rules/text-escaping.md | 4 +++- docs/rules/no-bad-blocks.md | 2 +- docs/rules/text-escaping.md | 4 +++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.README/rules/no-bad-blocks.md b/.README/rules/no-bad-blocks.md index ebbabaea7..42f917a13 100644 --- 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 index 0416152eb..e5a50c300 100644 --- 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 index 409b4249b..f362a8743 100644 --- 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 index 99d79ab92..e7c229b0a 100644 --- a/docs/rules/text-escaping.md +++ b/docs/rules/text-escaping.md @@ -34,13 +34,15 @@ 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`.