API documentation improvements #289
Conversation
|
Reviewed with w=0?. utACK |
| * privkey: pointer to a private key in DER format (cannot be NULL). | ||
| * privkeylen: length of the DER private key pointed to be privkey. | ||
| * Out: seckey: pointer to a 32-byte array for storing the private key. | ||
| * (cannot be NULL). |
There was a problem hiding this comment.
Any reason this functions in/out parameters are not in the same order as the documentation? Not that big an issue, just looked like a convention.
edit: upon further review, it seems there is no such convention being used here. Should there be though?
There was a problem hiding this comment.
I'd to have a convention of having all functions AND all documentation to have order: ctx/out/inout/in or ctx/in/inout/out.
There was a problem hiding this comment.
I'm personally in favour of ctx/in/inout/out
There was a problem hiding this comment.
There is a convention within C APIs to use out/in order, to mimic assignment.
There was a problem hiding this comment.
I guess that makes sense, but, I wouldn't be able to change the habit of reading things in terms of INPUT -> OUTPUT.
It'd be similar to seeing an anonymous function callback being used with the callback passed before arguments to the function.
There was a problem hiding this comment.
I prefer out/in order, it is extremely common in C API's.
|
Addressed nits. |
|
|
||
| void bench_context_sign(void* arg) { | ||
| (void)arg; | ||
| int i; |
There was a problem hiding this comment.
I'm getting a "mixed declarations and code" warning for having int i after the (void)arg. Ditto in the above function.
|
ACK |
|
ACK. |
| * guaranteed to be portable between different platforms or versions. It is | ||
| * however guaranteed to be 65 bytes in size, and can be safely copied/moved. | ||
| * If you need to convert to a format suitable for storage or transmission, use | ||
| * the secp256k1_ecdsa_signature_serialize_* and |
There was a problem hiding this comment.
After-the-fact nit: "secp256k1_ecdsa_signature_serialize_*" appears twice. I'm guessing this is a mistake.
No description provided.