aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-06-22 17:52:25 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-06-22 17:52:25 +0200
commitd2c5950762192a447c9023c77ee4f8195afb8fd8 (patch)
tree91ed9184042fa9ac4f67085e8cd61ba337c265bf
parent5416b61f89155b475fa5674898b8ff963aa443b5 (diff)
downloadmarkdown-rs-d2c5950762192a447c9023c77ee4f8195afb8fd8.tar.gz
markdown-rs-d2c5950762192a447c9023c77ee4f8195afb8fd8.tar.bz2
markdown-rs-d2c5950762192a447c9023c77ee4f8195afb8fd8.zip
Update todo
Diffstat (limited to '')
-rw-r--r--readme.md2
-rw-r--r--src/parser.rs2
2 files changed, 3 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index 01a911b..f5889ed 100644
--- a/readme.md
+++ b/readme.md
@@ -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);