Merge rust-bitcoin#4596: Correct hash algorithm name in RIPEMD160 documentation

apoelstra · apoelstra · commit 02e857582cc8 · 2025-06-05T14:33:49.000Z
e9f7ae4 Correct hash algorithm name in RIPEMD160 documentation (David Klank) Pull request description: Corrected the documentation comment for the `new()` method in the RIPEMD160 `HashEngine` struct. The comment incorrectly stated it constructs a "SHA256 hash engine" when it actually constructs a RIPEMD160 hash engine. ACKs for top commit: tcharding: ACK e9f7ae4 apoelstra: ACK e9f7ae4; successfully ran local tests Tree-SHA512: 3935f502709dc8ec570d7f112efbc4d55349f7072342ad0278ee2525bbf39ca1d7f60bcef0ad0a3bdcf3e67b2548d89bc01435532d848595a9824f4ec9e74bb7
diff --git a/hashes/src/ripemd160/mod.rs b/hashes/src/ripemd160/mod.rs
@@ -62,7 +62,7 @@ pub struct HashEngine {
 }
 
 impl HashEngine {
-    /// Constructs a new SHA256 hash engine.
+    /// Constructs a new RIPEMD160 hash engine.
     pub const fn new() -> Self {
         Self {
             h: [0x67452301, 0xefcdab89, 0x98badcfe, 0x10325476, 0xc3d2e1f0],

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ pub struct HashEngine {`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`impl HashEngine {`
`65`		`- /// Constructs a new SHA256 hash engine.`
	`65`	`+ /// Constructs a new RIPEMD160 hash engine.`
`66`	`66`	`pub const fn new() -> Self {`
`67`	`67`	`Self {`
`68`	`68`	`h: [0x67452301, 0xefcdab89, 0x98badcfe, 0x10325476, 0xc3d2e1f0],`