Update docs/USING_ADVANCED.md

markedjs · Mar 19, 2020 · 9f2c0d1 · 9f2c0d1
1 parent 885d728
commit 9f2c0d1
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/docs/USING_ADVANCED.md b/docs/USING_ADVANCED.md
@@ -43,7 +43,7 @@ console.log(marked(markdownString));
 |Member      |Type      |Default  |Since    |Notes         |
 |:-----------|:---------|:--------|:--------|:-------------|
 |baseUrl     |`string`  |`null`   |0.3.9    |A prefix url for any relative link. |
-|breaks      |`boolean` |`false`  |v0.2.7   |If true, add `<br>` on a single line break (copies GitHub comments). Requires `gfm` be `true`.|
+|breaks      |`boolean` |`false`  |v0.2.7   |If true, add `<br>` on a single line break (copies GitHub behavior on comments, but not on rendered markdown files). Requires `gfm` be `true`.|
 |gfm         |`boolean` |`true`   |v0.2.1   |If true, use approved [GitHub Flavored Markdown (GFM) specification](https://github.github.com/gfm/).|
 |headerIds   |`boolean` |`true`   |v0.4.0   |If true, include an `id` attribute when emitting headings (h1, h2, h3, etc).|
 |headerPrefix|`string`  |`''`     |v0.3.0   |A string to prefix the `id` attribute when emitting headings (h1, h2, h3, etc).|