docs: Fix return value of _tagged_sha256

real-or-random · real-or-random · commit f67b2249e6a5 · 2022-03-17T22:41:36.000+01:00
diff --git a/include/secp256k1.h b/include/secp256k1.h
@@ -814,7 +814,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_combine(
  *  implementations optimized for a specific tag can precompute the SHA256 state
  *  after hashing the tag hashes.
  *
- *  Returns 0 if the arguments are invalid and 1 otherwise.
+ *  Returns: 1 always.
  *  Args:    ctx: pointer to a context object
  *  Out:  hash32: pointer to a 32-byte array to store the resulting hash
  *  In:      tag: pointer to an array containing the tag

Original file line number	Diff line number	Diff line change
`@@ -814,7 +814,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_combine(`
`814`	`814`	`* implementations optimized for a specific tag can precompute the SHA256 state`
`815`	`815`	`* after hashing the tag hashes.`
`816`	`816`	`*`
`817`		`- * Returns 0 if the arguments are invalid and 1 otherwise.`
	`817`	`+ * Returns: 1 always.`
`818`	`818`	`* Args: ctx: pointer to a context object`
`819`	`819`	`* Out: hash32: pointer to a 32-byte array to store the resulting hash`
`820`	`820`	`* In: tag: pointer to an array containing the tag`