summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--dhall_core/src/lib.rs5
-rw-r--r--dhall_generated_parser/src/lib.rs7
-rw-r--r--dhall_generator/src/lib.rs5
3 files changed, 17 insertions, 0 deletions
diff --git a/dhall_core/src/lib.rs b/dhall_core/src/lib.rs
index 62c0ecd..3db8222 100644
--- a/dhall_core/src/lib.rs
+++ b/dhall_core/src/lib.rs
@@ -7,6 +7,11 @@
clippy::type_complexity
)]
+//! This crate contains the core AST-handling primitives for the [dhall-rust][dhall-rust] crate.
+//! This is highly unstable and breaks regularly; use at your own risk.
+//!
+//! [dhall-rust]: https://github.com/Nadrieril/dhall-rust
+
mod core;
pub use crate::core::*;
mod import;
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.
diff --git a/dhall_generator/src/lib.rs b/dhall_generator/src/lib.rs
index e67f2aa..9cf944a 100644
--- a/dhall_generator/src/lib.rs
+++ b/dhall_generator/src/lib.rs
@@ -1,3 +1,8 @@
+//! This crate contains the code-generation primitives for the [dhall-rust][dhall-rust] crate.
+//! This is highly unstable and breaks regularly; use at your own risk.
+//!
+//! [dhall-rust]: https://github.com/Nadrieril/dhall-rust
+
extern crate proc_macro;
mod derive;