From 4a47896c9cd1632fd911d1b85c03ed961001d7c4 Mon Sep 17 00:00:00 2001
From: Jack Grigg <jack@electriccoin.co>
Date: Mon, 11 Dec 2023 18:40:43 +0000
Subject: [PATCH] Add module-level documentation, deny unsafe code, deny broken
 links

---
 src/lib.rs | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/src/lib.rs b/src/lib.rs
index 03e019f..87b494c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,4 +1,15 @@
-//! Structs and constants specific to the Sapling shielded pool.
+//! # sapling
+//!
+//! ## Nomenclature
+//!
+//! All types in the `sapling` crate, unless otherwise specified, are Sapling-specific
+//! types. For example, [`Address`] is documented as being a shielded payment address; we
+//! implicitly mean it is an Sapling payment address (as opposed to e.g. an Orchard
+//! payment address, which is also shielded).
+
+// Catch documentation errors caused by code changes.
+#![deny(rustdoc::broken_intra_doc_links)]
+#![deny(unsafe_code)]
 
 mod address;
 pub mod builder;