What the developer wrote
Authored by Jamil Lambert, PhD
Add missing doc inline
What changed, and why it matters
This commit adds a missing documentation attribute to a public type alias in the rust-bitcoin hashes library. It only affects how the SHA3-256 hash type appears in generated API documentation and has no security or runtime effect.
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 change adds #[doc(inline)] to the pub use sha3_256::Hash as Sha3_256; re-export in hashes/src/lib.rs. This makes the alias render inline in rustdoc, matching the pattern used for adjacent re-exports. There is no code behavior change, no API change, and no security impact.
Changed components
hashes/src/lib.rs documentation attribute for Sha3_256 re-exportInspect captured patch +1 / −0
diff --git a/hashes/src/lib.rs b/hashes/src/lib.rs
index 5b28c138..9d54c427 100644
--- a/hashes/src/lib.rs
+++ b/hashes/src/lib.rs
@@ -144,6 +144,7 @@ pub use sha256d::Hash as Sha256d;
#[doc(inline)]
pub use sha384::Hash as Sha384;
/// SHA3-256: Alias for the [`sha3_256::Hash`] hash type.
+#[doc(inline)]
pub use sha3_256::Hash as Sha3_256;
/// SHA-512: Alias for the [`sha512::Hash`] hash type.
#[doc(inline)]
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.