What the developer wrote
Authored by Jamil Lambert, PhD
Docs cleanup
Add a couple of missing full stops and capital letters.
What changed, and why it matters
This commit only fixes punctuation and capitalization in code comments (documentation). No program logic, behavior, or security properties were changed.
No action required. This is a non-functional documentation cleanup.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies three documentation comments in hashes/src/sha256/mod.rs and hashes/src/sha256d/mod.rs. It adds missing periods and capitalizes the first letter of sentences. No executable code, function signatures, or cryptographic logic were altered.
Changed components
hashes/src/sha256/mod.rshashes/src/sha256d/mod.rsInspect captured patch +3 / −3
diff --git a/hashes/src/sha256/mod.rs b/hashes/src/sha256/mod.rs
index 0ae970d0..e59c8a6b 100644
--- a/hashes/src/sha256/mod.rs
+++ b/hashes/src/sha256/mod.rs
@@ -62,7 +62,7 @@ impl Hash {
Hash(hash)
}
- /// Iterate the sha256 algorithm to turn a sha256 hash into a sha256d hash
+ /// Iterate the sha256 algorithm to turn a sha256 hash into a sha256d hash.
#[must_use]
pub fn hash_again(&self) -> sha256d::Hash { sha256d::Hash::from_byte_array(hash(&self.0).0) }
@@ -284,7 +284,7 @@ pub mod error {
}
impl MidstateError {
- /// Returns block-aligned midstate
+ /// Returns block-aligned midstate.
pub const fn midstate(&self) -> &Midstate { &self.block_aligned_midstate }
/// returns the unprocessed bytes remaining in the buffer.
diff --git a/hashes/src/sha256d/mod.rs b/hashes/src/sha256d/mod.rs
index 9f412c0a..d0f38f41 100644
--- a/hashes/src/sha256d/mod.rs
+++ b/hashes/src/sha256d/mod.rs
@@ -12,7 +12,7 @@ crate::internal_macros::general_hash_type! {
}
impl Hash {
- /// computes double-sha256 of multiple 64-byte blocks in parallel.
+ /// Computes double-SHA256 of multiple 64-byte blocks in parallel.
pub fn hash_64_many(outputs: &mut [[u8; 32]], inputs: &[[u8; 64]]) {
sha256::HashEngine::sha256d_64(outputs, inputs);
}
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.