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/character_escape.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 '')
-rw-r--r-- | src/construct/character_escape.rs | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/construct/character_escape.rs b/src/construct/character_escape.rs index 5ea995e..7bab42d 100644 --- a/src/construct/character_escape.rs +++ b/src/construct/character_escape.rs @@ -1,5 +1,5 @@ -//! Character escapes are a construct that occurs in the string and text -//! content types. +//! Character escapes are a construct that occurs in the [string][] and +//! [text][] content types. //! //! They’re formed with the following BNF: //! @@ -22,9 +22,11 @@ //! * [`character-escape.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-core-commonmark/dev/lib/character-escape.js) //! * [*§ 2.4 Backslash escapes* in `CommonMark`](https://spec.commonmark.org/0.30/#backslash-escapes) //! +//! [string]: crate::content::string +//! [text]: crate::content::text //! [character reference]: crate::construct::character_reference //! -//! <!-- To do: link `hard_break_escape`, `string`, `text` --> +//! <!-- To do: link `hard_break_escape` --> use crate::tokenizer::{Code, State, StateFnResult, TokenType, Tokenizer}; |