What the developer wrote
Authored by Mitchell Bagot
Make address module errors no_inline
As part of the process of moving errors to error submodules, all error
types at the top-level should be no_inline.
What changed, and why it matters
This commit changes a single documentation attribute for re-exported error types in the address module. It tells Rust's documentation generator not to inline the descriptions of those errors on the parent module page. There is no runtime code change, no bug fix, and no security relevance.
No action needed. This is a non-functional documentation formatting change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff changes #[doc(inline)] to #[doc(no_inline)] on a public re-export of error types in bitcoin/src/address/mod.rs. This is a documentation-layout convention as part of moving errors into an error submodule. It affects only rustdoc output and has no effect on compiled behavior, APIs, or memory safety.
Changed components
bitcoin/src/address/mod.rs documentation re-exportsInspect captured patch +1 / −1
diff --git a/bitcoin/src/address/mod.rs b/bitcoin/src/address/mod.rs
index a7a5d3e3..48c9d946 100644
--- a/bitcoin/src/address/mod.rs
+++ b/bitcoin/src/address/mod.rs
@@ -71,7 +71,7 @@ use crate::script::{
use crate::taproot::TapNodeHash;
#[rustfmt::skip] // Keep public re-exports separate.
-#[doc(inline)]
+#[doc(no_inline)]
pub use self::error::{
Base58Error, Bech32Error, FromScriptError, InvalidBase58PayloadLengthError,
InvalidLegacyPrefixError, LegacyAddressTooLongError, NetworkValidationError,
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.