From 9adc70dcde9ba1801775a908ce9df7be94c2c633 Mon Sep 17 00:00:00 2001
From: Jack Grigg <jack@electriccoin.co>
Date: Mon, 11 Dec 2023 18:52:40 +0000
Subject: [PATCH] Slightly improve crate-level documentation

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

diff --git a/src/lib.rs b/src/lib.rs
index 4a8caeb..16d438b 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,4 +1,11 @@
-//! Structs and constants specific to the Sapling shielded pool.
+//! # sapling
+//!
+//! ## Nomenclature
+//!
+//! All types in the `sapling-crypto` crate, unless otherwise specified, are
+//! Sapling-specific types. For example, [`PaymentAddress`] 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)]