What changed, and why it matters
This commit only updates documentation comments in three Rust source files to add clickable cross-references (rustdoc links). No executable code, logic, or behavior was changed. It cannot affect security.
No security action needed. Treat as a normal documentation improvement.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff consists entirely of rustdoc comment edits in hashes/src/lib.rs, hashes/src/macros.rs, and hashes/src/sha256/mod.rs. Identifiers such as HashEngine, HashEngine::finalize, Tag, and Midstate are wrapped in rustdoc link brackets so they generate hyperlinks in generated documentation. There are no code, API, or dependency changes.
Changed components
hashes/src/lib.rshashes/src/macros.rshashes/src/sha256/mod.rsInspect captured patch +4 / −4
diff --git a/hashes/src/lib.rs b/hashes/src/lib.rs
index 493254fb..c2892c87 100644
--- a/hashes/src/lib.rs
+++ b/hashes/src/lib.rs
@@ -32,7 +32,7 @@
//! ```
//!
//!
-//! Hashing content using [`std::io::Write`] on a `HashEngine`:
+//! Hashing content using [`std::io::Write`] on a [`HashEngine`]:
//!
//! ```
//! # #[cfg(feature = "std")] {
@@ -178,7 +178,7 @@ pub trait HashEngine: Clone {
/// The `Hash` type returned when finalizing this engine.
type Hash: Hash;
- /// The byte array that is used internally in `finalize`.
+ /// The byte array that is used internally in [`HashEngine::finalize`].
type Bytes: Copy + IsByteArray;
/// Length of the hash, in bytes.
diff --git a/hashes/src/macros.rs b/hashes/src/macros.rs
index 78e1718d..489f9dd0 100644
--- a/hashes/src/macros.rs
+++ b/hashes/src/macros.rs
@@ -9,7 +9,7 @@
/// Macro used to define a tag.
///
-/// Defines new struct and implements `Tag` for it.
+/// Defines new struct and implements [`Tag`](crate::sha256t::Tag) for it.
///
/// The syntax is:
///
diff --git a/hashes/src/sha256/mod.rs b/hashes/src/sha256/mod.rs
index 27dfe3db..7d29fb1d 100644
--- a/hashes/src/sha256/mod.rs
+++ b/hashes/src/sha256/mod.rs
@@ -261,7 +261,7 @@ impl convert::AsRef<[u8]> for Midstate {
fn as_ref(&self) -> &[u8] { &self.bytes }
}
-/// `Midstate` invariant violated (not a multiple of 64).
+/// [`Midstate`] invariant violated (not a multiple of 64).
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MidstateError {
/// The invalid number of bytes hashed.
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.