Fix description of pico_sha256_cleanup

peterharperuk · peterharperuk · commit 3b3155b391a6 · 2025-01-29T13:09:45.000Z
diff --git a/src/rp2_common/pico_sha256/include/pico/sha256.h b/src/rp2_common/pico_sha256/include/pico/sha256.h
@@ -62,7 +62,7 @@ typedef struct pico_sha256_state {
  *  \ingroup pico_sha256
  *
  * Release the internal lock on the SHA-256 hardware.
- * Fails if the internal lock was not claimed.
+ * Does nothing if the internal lock was not claimed.
  *
  * @param state A pointer to a pico_sha256_state_t instance
  */

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ typedef struct pico_sha256_state {`
`62`	`62`	`* \ingroup pico_sha256`
`63`	`63`	`*`
`64`	`64`	`* Release the internal lock on the SHA-256 hardware.`
`65`		`- * Fails if the internal lock was not claimed.`
	`65`	`+ * Does nothing if the internal lock was not claimed.`
`66`	`66`	`*`
`67`	`67`	`* @param state A pointer to a pico_sha256_state_t instance`
`68`	`68`	`*/`