From 90889ac38dee7b3ad3c9b6c8b3e5aeb66e8b5846 Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Thu, 30 Jun 2022 11:46:43 +0200 Subject: Refactor some docs, fix some grammar --- src/construct/heading_setext.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'src/construct/heading_setext.rs') 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. -- cgit