What the developer wrote
Authored by Tobin C. Harding
primitives: Document re-exports
As we do in `units` document in the crate level rustdocs that the
`primitives` types are all re-exported at the same place in `bitcoin`.
What changed, and why it matters
This commit only adds a documentation comment to the top of a Rust source file. It explains that the `primitives` crate's types are re-exported in the main `bitcoin` crate, so users do not need to import `primitives` directly. There are no code changes, no bug fixes, and no security implications.
No action needed; this is a documentation-only change with no security relevance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds three lines of crate-level rustdoc to primitives/src/lib.rs. It documents the re-export pattern already used in the units crate. No APIs, logic, dependencies, or build configuration were modified.
Changed components
primitives/src/lib.rs documentation onlyInspect captured patch +3 / −0
diff --git a/primitives/src/lib.rs b/primitives/src/lib.rs
index 5eab0d51..0b8fe699 100644
--- a/primitives/src/lib.rs
+++ b/primitives/src/lib.rs
@@ -4,6 +4,9 @@
//!
//! Primitive data types that are used throughout the [`rust-bitcoin`] ecosystem.
//!
+//! If you are using `rust-bitcoin` then you do not need to access this crate directly. Everything
+//! here is re-exported in `rust-bitcoin` at the same path.
+//!
//! This crate can be used in a no-std environment but a lot of the functionality requires an
//! allocator i.e., requires the `alloc` feature to be enabled.
//!
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.