docs: Clarify doubleQuotedMinMultiLineLength option (closes #512)

eemeli · Feb 24, 2024 · 1838a66 · 1838a66
1 parent 9a8aa0d
commit 1838a66
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/docs/03_options.md b/docs/03_options.md
@@ -155,7 +155,7 @@ Used by: `stringify()` and `doc.toString()`
 | defaultStringType              | `'BLOCK_FOLDED' ⎮ 'BLOCK_LITERAL' ⎮` `'QUOTE_DOUBLE' ⎮ 'QUOTE_SINGLE' ⎮` `'PLAIN'`        | `'PLAIN'` | The default type of string literal used to stringify values.                                                                                                                                                                  |
 | directives                     | `boolean ⎮ null`                                                                          | `null`    | Include directives in the output. If `true`, at least the document-start marker `---` is always included. If `false`, no directives or marker is ever included. If `null`, directives and marker may be included if required. |
 | doubleQuotedAsJSON             | `boolean`                                                                                 | `false`   | Restrict double-quoted strings to use JSON-compatible syntax.                                                                                                                                                                 |
-| doubleQuotedMinMultiLineLength | `number`                                                                                  | `40`      | Minimum length for double-quoted strings to use multiple lines to represent the value.                                                                                                                                        |
+| doubleQuotedMinMultiLineLength | `number`                                                                                  | `40`      | Minimum length for double-quoted strings to use multiple lines to represent the value instead of escaping newlines.                                                                                                           |
 | falseStr                       | `string`                                                                                  | `'false'` | String representation for `false` values.                                                                                                                                                                                     |
 | flowCollectionPadding          | `boolean`                                                                                 | `true`    | When true, a single space of padding will be added inside the delimiters of non-empty single-line flow collections.                                                                                                           |
 | indent                         | `number`                                                                                  | `2`       | The number of spaces to use when indenting code. Should be a strictly positive integer.                                                                                                                                       |