doc: correct API docs for ECDSA signing out-params (s/array/signature object/) #1851

pull theStack wants to merge 1 commits into bitcoin-core:master from theStack:doc-correct_sig_outparams changing 2 files +2 −2

theStack commented at 4:10 PM on April 29, 2026: contributor

This PR is a late follow-up to #282, adapting the signature out param description to the API change.

This is currently a minimum-diff based on existing API doc descriptions in the touched header files (for e.g. _ecdsa_signature_parse_{compact,der}, _ecdsa_recoverable_signature_parse_compact). For more consistency across modules, one could adopt the wording used in the musig module, e.g. "pointer to a structure to store the created signature".
doc: correct API docs for ECDSA signing out-params (s/array/signature object/) 40a0d874a6
real-or-random added the label user-documentation on Apr 30, 2026
real-or-random added the label tweak/refactor on Apr 30, 2026
real-or-random removed the label tweak/refactor on Apr 30, 2026
real-or-random added the label bug on Apr 30, 2026
real-or-random commented at 12:56 PM on April 30, 2026: contributor

For more consistency across modules, one could adopt the wording used in the musig module, e.g. "pointer to a structure to store the created signature".

We say "public key object" or "signature object" in other places. It's short and clear. I'd rather change the "structure" thing for consistency.
real-or-random approved
real-or-random commented at 1:04 PM on April 30, 2026: contributor

utACK 40a0d874a6805e3065341ce5bd96384b7a7caeeb

Nice, this doc bug is over 10 years old. It dates back to https://github.com/bitcoin-core/secp256k1/commit/74a2acdb8a3d3899877343f4b3fbfa15ba31fc1e.

Contributors

theStack

real-or-random

Labels

bug user-documentation

Linked (view graph)

#282 [API CHANGE] Introduce pubkey and signature types