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/heading_atx.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/heading_atx.rs')
| -rw-r--r-- | src/construct/heading_atx.rs | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/construct/heading_atx.rs b/src/construct/heading_atx.rs index b3aef1b..3be8c99 100644 --- a/src/construct/heading_atx.rs +++ b/src/construct/heading_atx.rs @@ -1,4 +1,4 @@ -//! Heading (atx) is a construct that occurs in the flow content type. +//! Heading (atx) is a construct that occurs in the [flow] content type. //! //! They’re formed with the following BNF: //! @@ -38,11 +38,12 @@ //! * [`heading-atx.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-core-commonmark/dev/lib/heading-atx.js) //! * [*§ 4.2 ATX headings* in `CommonMark`](https://spec.commonmark.org/0.30/#atx-headings) //! +//! [flow]: crate::content::flow //! [html]: https://html.spec.whatwg.org/multipage/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements //! [wiki-setext]: https://en.wikipedia.org/wiki/Setext //! [atx]: http://www.aaronsw.com/2002/atx/ //! -//! <!-- To do: link `flow`, `setext` --> +//! <!-- To do: link `setext` --> use crate::constant::HEADING_ATX_OPENING_FENCE_SIZE_MAX; use crate::tokenizer::{Code, State, StateFnResult, TokenType, Tokenizer}; |