aboutsummaryrefslogtreecommitdiffstats
path: root/src/construct/thematic_break.rs
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-06-13 15:41:26 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-06-13 15:41:26 +0200
commit06b4ff3531874c95ec07b8440de526795408ef86 (patch)
treeb412e5187d839e2ff9ee2cc4e4c2d743bc5d9cd6 /src/construct/thematic_break.rs
parent4277dac07db06f24ba30a75b4c1dec542e32dae8 (diff)
downloadmarkdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.tar.gz
markdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.tar.bz2
markdown-rs-06b4ff3531874c95ec07b8440de526795408ef86.zip
Add some improved docs
Diffstat (limited to 'src/construct/thematic_break.rs')
-rw-r--r--src/construct/thematic_break.rs5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/construct/thematic_break.rs b/src/construct/thematic_break.rs
index 15ebac7..7a4f71a 100644
--- a/src/construct/thematic_break.rs
+++ b/src/construct/thematic_break.rs
@@ -1,5 +1,5 @@
//! Thematic breaks, sometimes called horizontal rules, are a construct that
-//! occurs in the flow content type.
+//! occurs in the [flow][] content type.
//!
//! They’re formed with the following BNF:
//!
@@ -38,9 +38,10 @@
//! * [`thematic-break.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-core-commonmark/dev/lib/thematic-break.js)
//! * [*§ 4.1 Thematic breaks* in `CommonMark`](https://spec.commonmark.org/0.30/#thematic-breaks)
//!
+//! [flow]: crate::content::flow
//! [html]: https://html.spec.whatwg.org/multipage/grouping-content.html#the-hr-element
//!
-//! <!-- To do: link `flow` -->
+//! <!-- To do: link `lists`, `setext heading` -->
use crate::constant::THEMATIC_BREAK_MARKER_COUNT_MIN;
use crate::tokenizer::{Code, State, StateFnResult, TokenType, Tokenizer};