Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

feat: add doc comments to literate haskell structs

Grant Lemonse3d7acf234e9
diff --git a/harper-literate-haskell/src/lib.rs b/harper-literate-haskell/src/lib.rs
index c18efd9df..f56515a75 100644
--- a/harper-literate-haskell/src/lib.rs
+++ b/harper-literate-haskell/src/lib.rs
@@ -8,6 +8,7 @@ mod masker;
use itertools::Itertools;
use masker::LiterateHaskellMasker;
+/// Parses a Literate Haskell document by masking out the code and considering text as Markdown.
pub struct LiterateHaskellParser;
impl LiterateHaskellParser {
diff --git a/harper-literate-haskell/src/masker.rs b/harper-literate-haskell/src/masker.rs
index 3038cb6f1..daa20ff75 100644
--- a/harper-literate-haskell/src/masker.rs
+++ b/harper-literate-haskell/src/masker.rs
@@ -1,5 +1,8 @@
use harper_core::{CharStringExt, Mask, Masker, Span};
+/// Masker for selecting portions of Literate Haskell documents.
+///
+/// Based on the specifications outlined at https://wiki.haskell.org/Literate_programming.
pub struct LiterateHaskellMasker {
text: bool,
code: bool,