diff options
| -rw-r--r-- | readme.md | 2 | ||||
| -rw-r--r-- | src/parser.rs | 2 |
2 files changed, 3 insertions, 1 deletions
@@ -70,7 +70,6 @@ cargo doc --document-private-items - [ ] (1) Go through all bnf - [ ] (1) Go through all docs -- [ ] (1) Add module docs to parser - [ ] (1) Add overview docs on how everything works #### Parse @@ -234,6 +233,7 @@ cargo doc --document-private-items - [x] (1) Get definition identifiers (definition) - [x] (1) Add docs to `normalize_identifier` - [x] (1) Add docs for how references and definitions match +- [x] (1) Add module docs to parser ### Extensions diff --git a/src/parser.rs b/src/parser.rs index 250ff0c..49d99d3 100644 --- a/src/parser.rs +++ b/src/parser.rs @@ -1,9 +1,11 @@ //! Turn a string of markdown into events. + // To do: this should start with `containers`, when they’re done. use crate::content::flow::flow; use crate::tokenizer::{as_codes, Code, Event, Point}; /// Turn a string of markdown into events. +/// /// Passes the codes back so the compiler can access the source. pub fn parse(value: &str) -> (Vec<Event>, Vec<Code>) { let codes = as_codes(value); |