diff options
| author |  Titus Wormer <tituswormer@gmail.com> | 2022-08-12 14:21:53 +0200 |
|---|---|---|
| committer | Titus Wormer <tituswormer@gmail.com> | 2022-08-12 14:21:53 +0200 |
| commit | 504729a4a0c8f3e0d8fc9159e0273150b169e184 (patch) | |
| tree | a6bf291322decccd6011580337b1feed6151b554 /src/construct/heading_setext.rs | |
| parent | db5a491e6c2223d1db9b458307431a54db3c40f2 (diff) | |
| download | markdown-rs-504729a4a0c8f3e0d8fc9159e0273150b169e184.tar.gz markdown-rs-504729a4a0c8f3e0d8fc9159e0273150b169e184.tar.bz2 markdown-rs-504729a4a0c8f3e0d8fc9159e0273150b169e184.zip | |
Refactor to improve docs of each function
Diffstat (limited to 'src/construct/heading_setext.rs')
| -rw-r--r-- | src/construct/heading_setext.rs | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/construct/heading_setext.rs b/src/construct/heading_setext.rs index e31ce76..8485f5a 100644 --- a/src/construct/heading_setext.rs +++ b/src/construct/heading_setext.rs @@ -65,7 +65,7 @@ use crate::state::{Name as StateName, State}; use crate::tokenizer::Tokenizer; use crate::util::skip::opt_back as skip_opt_back; -/// At a line ending, presumably an underline. +/// At start of heading (setext) underline. /// /// ```markdown /// | aa @@ -100,7 +100,7 @@ pub fn start(tokenizer: &mut Tokenizer) -> State { } } -/// After optional whitespace, presumably an underline. +/// After optional whitespace, at `-` or `=`. /// /// ```markdown /// | aa @@ -118,7 +118,7 @@ pub fn before(tokenizer: &mut Tokenizer) -> State { } } -/// In an underline sequence. +/// In sequence. /// /// ```markdown /// | aa @@ -143,7 +143,7 @@ pub fn inside(tokenizer: &mut Tokenizer) -> State { } } -/// After an underline sequence, after optional whitespace. +/// After sequence, after optional whitespace. /// /// ```markdown /// | aa |