Slightly improve crate-level documentation

This commit is contained in:
Jack Grigg 2023-12-11 18:52:40 +00:00
parent 37e574d0aa
commit 9adc70dcde
1 changed files with 8 additions and 1 deletions

View File

@ -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)]