docs: correct `pubkey` param descriptions for `secp256k1_keypair_{xonly_,}pub` #1341

pull theStack wants to merge 1 commits into bitcoin-core:master from theStack:docs-fix_pubkey_param_desc_for_keypair_funcs changing 1 files +4 −6

theStack commented at 4:48 PM on June 11, 2023: contributor

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 https://github.com/bitcoin-core/secp256k1/commit/b8f8b99f0fb3a5cd4c6fb1c9c8dfed881839e19e (PR #1089), which also explains why invalid inputs for the affected functions are in practice only possible in violation of the type system.

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 b8f8b99f0fb3a5cd4c6fb1c9c8dfed881839e19e (PR #1089), which also
explains why invalid inputs for the affected functions are in practice
only possible in violation of the type system.

f3644287b1

real-or-random added the label documentation on Jun 11, 2023
real-or-random approved
real-or-random commented at 4:57 PM on June 11, 2023: contributor

ACK https://github.com/bitcoin-core/secp256k1/pull/1341/commits/f3644287b10cd7339fbb0e35e953235351f5efb6 because it's consistent with the other docs
jonasnick commented at 8:38 AM on June 12, 2023: contributor

ACK f3644287b10cd7339fbb0e35e953235351f5efb6
jonasnick merged this on Jun 12, 2023
jonasnick closed this on Jun 12, 2023
sipa referenced this in commit 901336eee7 on Jun 21, 2023
vmta referenced this in commit 8f03457eed on Jul 1, 2023
hebasto referenced this in commit 270d2b37b8 on Jul 21, 2023
delta1 referenced this in commit 3f32c20932 on Aug 8, 2023
delta1 referenced this in commit 31ac0c1081 on Aug 31, 2023
janus referenced this in commit c4348d88db on Sep 11, 2023
div72 referenced this in commit af627d47c3 on Apr 12, 2025
str4d referenced this in commit 5a6bf5f178 on Jun 4, 2025

Contributors

Labels

Linked (view graph)

#1089 Schnorrsig API improvements