summaryrefslogtreecommitdiff
path: root/dhall_generated_parser
diff options
context:
space:
mode:
authorNadrieril2019-04-14 21:39:44 +0200
committerNadrieril2019-04-14 21:39:44 +0200
commit5bdded94d9197abbcf41313649619acb1baa62b7 (patch)
tree6427ef49f99b7b8f9e2eec2a636b43304a478ce5 /dhall_generated_parser
parent0044b1d32292aae3d10f9d8cb08bb0beec9bb05c (diff)
Document roughly the dhall subcrates
Closes #72
Diffstat (limited to 'dhall_generated_parser')
-rw-r--r--dhall_generated_parser/src/lib.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/dhall_generated_parser/src/lib.rs b/dhall_generated_parser/src/lib.rs
index 97a0d54..527e657 100644
--- a/dhall_generated_parser/src/lib.rs
+++ b/dhall_generated_parser/src/lib.rs
@@ -1,3 +1,10 @@
+//! This crate only contains a [pest][pest]-generated parser for the [dhall][dhall] language.
+//! It is part of the [dhall-rust][dhall-rust] crate.
+//!
+//! [pest]: https://pest.rs
+//! [dhall]: https://dhall-lang.org/
+//! [dhall-rust]: https://github.com/Nadrieril/dhall-rust
+
// This crate only contains the grammar-generated parser. The rest of the
// parser is in dhall_core. This separation is because compiling the
// grammar-generated parser is extremely slow.