diff options
author | Titus Wormer <tituswormer@gmail.com> | 2022-06-13 15:41:26 +0200 |
---|---|---|
committer | Titus Wormer <tituswormer@gmail.com> | 2022-06-13 15:41:26 +0200 |
commit | 06b4ff3531874c95ec07b8440de526795408ef86 (patch) | |
tree | b412e5187d839e2ff9ee2cc4e4c2d743bc5d9cd6 /src/construct/blank_line.rs | |
parent | 4277dac07db06f24ba30a75b4c1dec542e32dae8 (diff) | |
download | markdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.tar.gz markdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.tar.bz2 markdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.zip |
Add some improved docs
Diffstat (limited to 'src/construct/blank_line.rs')
-rw-r--r-- | src/construct/blank_line.rs | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/construct/blank_line.rs b/src/construct/blank_line.rs index 7b7962b..7f794b9 100644 --- a/src/construct/blank_line.rs +++ b/src/construct/blank_line.rs @@ -1,4 +1,4 @@ -//! Blank lines are a construct that occurs in the flow content type. +//! Blank lines are a construct that occurs in the [flow][] content type. //! //! They’re formed with the following BNF: //! @@ -9,7 +9,7 @@ //! Blank lines are sometimes needed, such as to differentiate a paragraph //! from another paragraph. //! In several cases, blank lines are not needed between flow constructs, -//! such as between two headings. +//! such as between two [heading (atx)][heading-atx]s. //! Sometimes, whether blank lines are present, changes the behavior of how //! HTML is rendered, such as whether blank lines are present between list //! items in a list. @@ -23,7 +23,10 @@ //! * [`blank-line.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-core-commonmark/dev/lib/blank-line.js) //! * [*§ 4.9 Blank lines* in `CommonMark`](https://spec.commonmark.org/0.30/#blank-lines) //! -//! <!-- To do: link `flow`, `heading`, `list`, `paragraph` --> +//! [flow]: crate::content::flow +//! [heading-atx]: crate::construct::heading_atx +//! +//! <!-- To do: link `list`, `paragraph` --> use crate::construct::partial_whitespace::start as whitespace; use crate::tokenizer::{Code, State, StateFnResult, TokenType, Tokenizer}; |