update doc comment to be relevant for quarto

Automattic · Mar 8, 2025 · 5507fb3 · 5507fb3
1 parent 136bc88
commit 5507fb3
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/harper-quarto/src/lib.rs b/harper-quarto/src/lib.rs
@@ -6,7 +6,9 @@ use harper_core::{
 mod masker;
 pub use masker::QuartoMasker;
 
-/// Parses a Literate Haskell document by masking out the code and considering text as Markdown.
+/// Parses a quarto document by ignoring the YAML header, and treating the remainder as Markdown.
+///
+/// TODO: Parse [quarto specific syntax elements](https://quarto.org/docs/authoring/markdown-basics.html)
 pub struct QuartoParser {
     inner: Lrc<dyn Parser>,
 }