hashes: Trivial change to internal docs
What the developer wrote
Authored by Tobin C. Harding
hashes: Trivial change to internal docs
What changed, and why it matters
This commit only rewrites internal documentation comments inside a Rust source file. No executable code, logic, or behavior changed. It is purely a formatting and wording cleanup of doc comments.
No action required. This is a non-functional documentation change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies only comments in hashes/src/internal_macros.rs. It rewraps and rephrases two bullet points in the documentation of the hash_trait_impls! and general_hash_type! macros. No macro expansion, generated code, trait bounds, or function bodies were altered.
Changed components
hashes/src/internal_macros.rs (documentation comments only)Inspect captured patch +5 / −4
diff --git a/hashes/src/internal_macros.rs b/hashes/src/internal_macros.rs
index 03ce6ba2..4972df95 100644
--- a/hashes/src/internal_macros.rs
+++ b/hashes/src/internal_macros.rs
@@ -9,13 +9,13 @@
/// # Parameters
///
/// * `$bits` - the number of bits this hash type has
-/// * `$reverse` - `bool` - `true` if the hash type should be displayed backwards, `false`
-/// otherwise.
+/// * `$reverse` - `bool`, `true` if the hash type should be displayed backwards, `false` otherwise.
/// * `$gen: $gent` - the generic type(s) and trait bound(s)
///
/// Restrictions on usage:
///
-/// * The `Hash` type in scope must provide `from_byte_array`, `to_byte_array`, and `as_byte_array` (e.g., via `hash_type_no_default!`).
+/// * The `Hash` type in scope must provide `from_byte_array`, `to_byte_array`, and
+/// `as_byte_array` (e.g., via `hash_type_no_default!`).
macro_rules! hash_trait_impls {
($bits:expr, $reverse:expr $(, $gen:ident: $gent:ident)*) => {
$crate::impl_bytelike_traits!(Hash, { $bits / 8 } $(, $gen: $gent)*);
@@ -61,7 +61,8 @@ pub(crate) use hash_trait_impls;
///
/// Restrictions on usage:
///
-/// * Requires a `HashEngine` type in this module implementing `Default` and `crate::HashEngine<Hash = Hash, Bytes = [u8; $len]>`.
+/// * Requires a `HashEngine` type in this module implementing `Default`
+/// and `crate::HashEngine<Hash = Hash, Bytes = [u8; $len]>`.
macro_rules! general_hash_type {
(
$(#[$type_attrs:meta])*
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.