Merge rust-bitcoin/rust-bitcoin#7097: units: Match rustdoc heading of other 1.0 crates
What changed, and why it matters
This commit is a documentation-only change. It updates the heading and first sentence of the crate-level documentation in the `units` crate to match the style used by other crates in the project. No code behavior was changed.
No action required. This is a non-security documentation formatting change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies only doc comments in units/src/lib.rs. It adds a markdown heading # Rust Bitcoin Unit Types, rephrases the opening sentence, and adds a rustdoc link reference to the rust-bitcoin GitHub repository. There are no functional code changes, no API changes, and no security implications.
Changed components
units/src/lib.rs (documentation only)Inspect captured patch +4 / −1
### units/src/lib.rs
@@ -1,6 +1,8 @@
// SPDX-License-Identifier: CC0-1.0
-//! Basic (numeric) types used by the Rust Bitcoin ecosystem.
+//! # Rust Bitcoin Unit Types
+//!
+//! Numeric data types that are used throughout the [`rust-bitcoin`] ecosystem.
//!
//! This crate contains basic types that have minimal requirements on the platform they run on.
//! Specifically, they do not require an allocator and they do not require `usize` to be at least
@@ -54,6 +56,7 @@
//!
//! [`bitcoin`]: https://docs.rs/bitcoin
//! [`bitcoin-primitives`]: https://docs.rs/bitcoin-primitives
+//! [`rust-bitcoin`]: <https://github.com/rust-bitcoin/rust-bitcoin>
#![no_std]
// Coding conventions.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.