Skip to content

Commit cb1a592

Browse files
committed
Merge bitcoin-core/secp256k1#1341: docs: correct pubkey param descriptions for secp256k1_keypair_{xonly_,}pub
f364428 docs: correct `pubkey` param descriptions for `secp256k1_keypair_{xonly_,}pub` (Sebastian Falbesoner) Pull request description: ACKs for top commit: real-or-random: ACK bitcoin-core/secp256k1@f364428 because it's consistent with the other docs jonasnick: ACK f364428 Tree-SHA512: cc4db4637301335ea9d23ac43bb3a78de54af79a5262dba2013945f87d80670c7ae1e106101a59c04225eb077e9a9e0ecc9d9d3bfe2d11cdc90f098ebd479f49
2 parents 60556c9 + f364428 commit cb1a592

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)