diff options
| author |  Titus Wormer <tituswormer@gmail.com> | 2022-06-30 11:46:43 +0200 |
|---|---|---|
| committer | Titus Wormer <tituswormer@gmail.com> | 2022-06-30 11:46:43 +0200 |
| commit | 90889ac38dee7b3ad3c9b6c8b3e5aeb66e8b5846 (patch) | |
| tree | b8cbfc1c43f23c7f1fa1367bcbeaeedbbbe18ef0 /src/construct/heading_setext.rs | |
| parent | 70ed10c131883553582a6dfce7f07eba6c1387fc (diff) | |
| download | markdown-rs-90889ac38dee7b3ad3c9b6c8b3e5aeb66e8b5846.tar.gz markdown-rs-90889ac38dee7b3ad3c9b6c8b3e5aeb66e8b5846.tar.bz2 markdown-rs-90889ac38dee7b3ad3c9b6c8b3e5aeb66e8b5846.zip | |
Refactor some docs, fix some grammar
Diffstat (limited to 'src/construct/heading_setext.rs')
| -rw-r--r-- | src/construct/heading_setext.rs | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/construct/heading_setext.rs b/src/construct/heading_setext.rs index 63f3c30..03a2e55 100644 --- a/src/construct/heading_setext.rs +++ b/src/construct/heading_setext.rs @@ -25,8 +25,10 @@ //! headings. //! Due to this limitation, it is recommended to use atx headings. //! -//! [Thematic breaks][thematic_break] formed with dashes (without whitespace) -//! can also form heading (setext). +//! [Thematic breaks][thematic_break] formed with dashes and without whitespace +//! could be interpreted as a heading (setext). +//! Which one forms depends on whether there is text directly in fron of the +//! sequence. //! //! > 🏛 **Background**: the word *setext* originates from a small markup //! > language by Ian Feldman from 1991. |