Skip to content

Commit

Permalink
Add module-level documentation, deny unsafe code, deny broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
str4d committed Dec 11, 2023
1 parent 3f16cd9 commit 4a47896
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -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;
Expand Down

0 comments on commit 4a47896

Please sign in to comment.