Skip to content

Commit b039833

Browse files
committed
docs(text-escaping): indicate defaults for escapeHTML
1 parent 964712b commit b039833

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

.README/rules/no-bad-blocks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This rule checks for multi-line-style comments which fail to meet the
66
criteria of a JSDoc block, namely that it should begin with two and only two
77
asterisks, but which appear to be intended as JSDoc blocks due to the presence
88
of whitespace followed by whitespace or asterisks, and
9-
an at-sign (`@`) and some non-whitespace (as with a jsdoc block tag).
9+
an at-sign (`@`) and some non-whitespace (as with a JSDoc block tag).
1010

1111
Exceptions are made for ESLint directive comments (which may use `@` in
1212
rule names).

.README/rules/text-escaping.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,13 @@ within it or your documentation.
1919
### `escapeHTML`
2020

2121
This option escapes all `<` and `&` characters (except those followed by
22-
whitespace which are treated as literals by Visual Studio Code).
22+
whitespace which are treated as literals by Visual Studio Code). Defaults to
23+
`false`.
2324

2425
### `escapeMarkdown`
2526

2627
This option escapes the first backtick (`` ` ``) in a paired sequence.
28+
Defaults to `false`.
2729

2830
## Context and settings
2931

docs/rules/no-bad-blocks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This rule checks for multi-line-style comments which fail to meet the
88
criteria of a JSDoc block, namely that it should begin with two and only two
99
asterisks, but which appear to be intended as JSDoc blocks due to the presence
1010
of whitespace followed by whitespace or asterisks, and
11-
an at-sign (`@`) and some non-whitespace (as with a jsdoc block tag).
11+
an at-sign (`@`) and some non-whitespace (as with a JSDoc block tag).
1212

1313
Exceptions are made for ESLint directive comments (which may use `@` in
1414
rule names).

docs/rules/text-escaping.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,15 @@ within it or your documentation.
3434
### <code>escapeHTML</code>
3535

3636
This option escapes all `<` and `&` characters (except those followed by
37-
whitespace which are treated as literals by Visual Studio Code).
37+
whitespace which are treated as literals by Visual Studio Code). Defaults to
38+
`false`.
3839

3940
<a name="user-content-text-escaping-options-escapemarkdown"></a>
4041
<a name="text-escaping-options-escapemarkdown"></a>
4142
### <code>escapeMarkdown</code>
4243

4344
This option escapes the first backtick (`` ` ``) in a paired sequence.
45+
Defaults to `false`.
4446

4547
<a name="user-content-text-escaping-context-and-settings"></a>
4648
<a name="text-escaping-context-and-settings"></a>

0 commit comments

Comments
 (0)