What the developer wrote
Authored by Mitchell Bagot
Fix blockdata module re-export docs
The module re-exports in bitcoin::blockdata currently have incorrect
docs due to missing #[doc(inline)] and incorrect use of /// comments.
Introduce #[doc(inline)] where appropriate.
Replace incorrect uses of doc comments with standard comments.
What changed, and why it matters
This commit only fixes how documentation appears for re-exported Rust modules. It changes some doc comments to regular comments and adds markers that control whether documentation is shown inline. There is no change to actual program logic, data handling, or security behavior.
No security action needed. Treat as a normal documentation fix.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch in bitcoin/src/blockdata/mod.rs is purely cosmetic for rustdoc output. It replaces a few /// doc comments with // non-doc comments and adds #[doc(inline)] attributes on re-exports so that generated documentation displays correctly. No executable code, APIs, parsing, serialization, or cryptographic operations are modified.
Changed components
bitcoin/src/blockdata/mod.rs documentation onlyInspect captured patch +7 / −4
diff --git a/bitcoin/src/blockdata/mod.rs b/bitcoin/src/blockdata/mod.rs
index 9758dc2a..6b1d75d8 100644
--- a/bitcoin/src/blockdata/mod.rs
+++ b/bitcoin/src/blockdata/mod.rs
@@ -22,8 +22,10 @@ pub use self::{
/// Implements `FeeRate` and associated features.
pub mod fee_rate {
#[cfg(feature = "serde")]
+ #[doc(inline)]
pub use units::fee_rate::serde;
- /// Re-export everything from the [`units::fee_rate`] module.
+ // Re-export everything from the [`units::fee_rate`] module.
+ #[doc(inline)]
pub use units::fee_rate::FeeRate;
}
@@ -39,7 +41,7 @@ pub mod locktime {
pub use crate::consensus::encode::{self, Decodable, Encodable};
- /// Re-export everything from the `units::locktime::absolute` module.
+ // Re-export everything from the `units::locktime::absolute` module.
#[rustfmt::skip] // Keep public re-exports separate.
#[doc(inline)]
pub use units::locktime::absolute::{error, Height, LockTime, MedianTimePast};
@@ -75,7 +77,7 @@ pub mod locktime {
//! There are two types of lock time: lock-by-height and lock-by-time, distinguished by
//! whether bit 22 of the `u32` consensus value is set.
- /// Re-export everything from the `units::locktime::relative` module.
+ // Re-export everything from the `units::locktime::relative` module.
#[doc(inline)]
pub use units::locktime::relative::{error, LockTime, NumberOf512Seconds, NumberOfBlocks};
#[doc(no_inline)]
@@ -96,6 +98,7 @@ pub mod locktime {
/// Implements `Weight` and associated features.
pub mod weight {
- /// Re-export everything from the [`units::weight`] module.
+ // Re-export everything from the [`units::weight`] module.
+ #[doc(inline)]
pub use units::weight::Weight;
}
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.