Skip to content

Commit

Permalink
Slightly improve crate-level documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
str4d committed Dec 11, 2023
1 parent 37e574d commit 9adc70d
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -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)]
Expand Down

0 comments on commit 9adc70d

Please sign in to comment.