diff options
| author |  Titus Wormer <tituswormer@gmail.com> | 2022-08-16 13:04:38 +0200 |
|---|---|---|
| committer | Titus Wormer <tituswormer@gmail.com> | 2022-08-16 13:04:38 +0200 |
| commit | 93d0b7c6465f4ffe220b3ddada729746b11eb6ce (patch) | |
| tree | e7907fb89a6660c5546d2ca128b2d48ec87539ae /src/construct/partial_space_or_tab.rs | |
| parent | 2379c2749916483be68dbf816a4c56cd59ced958 (diff) | |
| download | markdown-rs-93d0b7c6465f4ffe220b3ddada729746b11eb6ce.tar.gz markdown-rs-93d0b7c6465f4ffe220b3ddada729746b11eb6ce.tar.bz2 markdown-rs-93d0b7c6465f4ffe220b3ddada729746b11eb6ce.zip | |
Update some last docs, bnf grammars
Diffstat (limited to 'src/construct/partial_space_or_tab.rs')
| -rw-r--r-- | src/construct/partial_space_or_tab.rs | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/src/construct/partial_space_or_tab.rs b/src/construct/partial_space_or_tab.rs index 43cfd45..198dae2 100644 --- a/src/construct/partial_space_or_tab.rs +++ b/src/construct/partial_space_or_tab.rs @@ -1,4 +1,13 @@ -//! Several helpers to parse whitespace (`space_or_tab`, `space_or_tab_eol`). +//! Space or tab occurs in tons of places. +//! +//! ## Grammar +//! +//! Space or tab forms with the following BNF +//! (<small>see [construct][crate::construct] for character groups</small>): +//! +//! ```bnf +//! space_or_tab ::= 1*('\t' | ' ') +//! ``` //! //! ## References //! @@ -9,16 +18,16 @@ use crate::state::{Name as StateName, State}; use crate::subtokenize::link; use crate::tokenizer::Tokenizer; -/// Options to parse `space_or_tab`. +/// Configuration. #[derive(Debug)] pub struct Options { /// Minimum allowed bytes (inclusive). pub min: usize, /// Maximum allowed bytes (inclusive). pub max: usize, - /// Token type to use for whitespace events. + /// Name to use for events. pub kind: Name, - /// Connect this whitespace to the previous. + /// Connect this event to the previous. pub connect: bool, /// Embedded content type to use. pub content: Option<Content>, |