Skip to content

Commit f364428

Browse files
committed
docs: correct pubkey param descriptions for secp256k1_keypair_{xonly_,}pub
From an API perspective, the functions `secp256k1_keypair_pub` and `secp256k1_keypair_xonly_pub` always succeed (i.e. return the value 1), so the other cases in the `pubkey` parameter descriptions never happen and can hence be removed. Note that the "1 always" return value description was previously done in commit b8f8b99 (PR bitcoin#1089), which also explains why invalid inputs for the affected functions are in practice only possible in violation of the type system.
1 parent 60556c9 commit f364428

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

include/secp256k1_extrakeys.h

+4-6
Original file line numberDiff line numberDiff line change
@@ -185,9 +185,8 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_sec(
185185
/** Get the public key from a keypair.
186186
*
187187
* Returns: 1 always.
188-
* Args: ctx: pointer to a context object.
189-
* Out: pubkey: pointer to a pubkey object. If 1 is returned, it is set to
190-
* the keypair public key. If not, it's set to an invalid value.
188+
* Args: ctx: pointer to a context object.
189+
* Out: pubkey: pointer to a pubkey object, set to the keypair public key.
191190
* In: keypair: pointer to a keypair.
192191
*/
193192
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_pub(
@@ -203,9 +202,8 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_pub(
203202
*
204203
* Returns: 1 always.
205204
* Args: ctx: pointer to a context object.
206-
* Out: pubkey: pointer to an xonly_pubkey object. If 1 is returned, it is set
207-
* to the keypair public key after converting it to an
208-
* xonly_pubkey. If not, it's set to an invalid value.
205+
* Out: pubkey: pointer to an xonly_pubkey object, set to the keypair
206+
* public key after converting it to an xonly_pubkey.
209207
* pk_parity: Ignored if NULL. Otherwise, pointer to an integer that will be set to the
210208
* pk_parity argument of secp256k1_xonly_pubkey_from_pubkey.
211209
* In: keypair: pointer to a keypair.

0 commit comments

Comments
 (0)