What the developer wrote
Authored by Mitchell Bagot
Adjust error re-export doc inlining
Error re-exports in bitcoin and primitives should use #[doc(no_inline)]
to ensure that pure re-export types are rendered as re-exports and not
defined types of the module in docs.
Use #[doc(no_inline)] for BlockHashDecoderError in primitives and
PushBytesError, ParseTransactionError, and ParseOutPointError in
bitcoin.
What changed, and why it matters
This commit only changes how Rust documentation is generated for certain error types. It switches some re-exports from being shown as if they were defined in the current module to being shown as re-exports from another module. There is no change to actual code behavior, no security fix, and no vulnerability.
No security action needed. This is a documentation-only formatting change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch modifies #[doc(inline)] and #[doc(no_inline)] attributes on public re-exports in three files. These attributes only affect rustdoc rendering. The underlying types, visibility, and runtime behavior are unchanged. No logic, API, or memory-safety changes are present.
Changed components
bitcoin/src/blockdata/script/push_bytes.rsbitcoin/src/blockdata/transaction.rsprimitives/src/transaction.rsInspect captured patch +7 / −3
diff --git a/bitcoin/src/blockdata/script/push_bytes.rs b/bitcoin/src/blockdata/script/push_bytes.rs
index 31f1f660..23e93bbd 100644
--- a/bitcoin/src/blockdata/script/push_bytes.rs
+++ b/bitcoin/src/blockdata/script/push_bytes.rs
@@ -471,7 +471,7 @@ impl PushBytesErrorReport for core::convert::Infallible {
fn input_len(&self) -> usize { match *self {} }
}
-#[doc(inline)]
+#[doc(no_inline)]
pub use error::PushBytesError;
#[cfg(any(target_pointer_width = "16", target_pointer_width = "32"))]
diff --git a/bitcoin/src/blockdata/transaction.rs b/bitcoin/src/blockdata/transaction.rs
index 20dd224b..f40f1236 100644
--- a/bitcoin/src/blockdata/transaction.rs
+++ b/bitcoin/src/blockdata/transaction.rs
@@ -32,8 +32,10 @@ use crate::witness::Witness;
use crate::{internal_macros, Amount, FeeRate, Sequence, SignedAmount};
#[rustfmt::skip] // Keep public re-exports separate.
+#[doc(no_inline)]
+pub use primitives::transaction::{ParseTransactionError, ParseOutPointError};
#[doc(inline)]
-pub use primitives::transaction::{OutPoint, ParseTransactionError, ParseOutPointError, Transaction, Ntxid, Txid, Wtxid, Version, TxIn, TxOut};
+pub use primitives::transaction::{OutPoint, Transaction, Ntxid, Txid, Wtxid, Version, TxIn, TxOut};
impl Encodable for Txid {
fn consensus_encode<W: Write + ?Sized>(&self, w: &mut W) -> Result<usize, io::Error> {
diff --git a/primitives/src/transaction.rs b/primitives/src/transaction.rs
index f8897207..5f1129e3 100644
--- a/primitives/src/transaction.rs
+++ b/primitives/src/transaction.rs
@@ -49,7 +49,9 @@ use crate::{absolute, Amount, ScriptPubKeyBuf, ScriptSigBuf, Sequence, Weight, W
#[rustfmt::skip] // Keep public re-exports separate.
#[doc(inline)]
-pub use crate::hash_types::{Ntxid, Txid, Wtxid, BlockHashDecoder, BlockHashDecoderError, TxMerkleNodeDecoder, TxMerkleNodeDecoderError};
+pub use crate::hash_types::{Ntxid, Txid, Wtxid, BlockHashDecoder, TxMerkleNodeDecoder, TxMerkleNodeDecoderError};
+#[doc(no_inline)]
+pub use crate::hash_types::BlockHashDecoderError;
/// Bitcoin transaction.
///
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.