include: make docs more consistent #1476

1. 
   jonasnick commented at 5:15 pm on January 4, 2024: contributor
2. include: remove obvious "cannot be NULL" doc e3f690015a
3. include: make doc about ctx more consistent

   Replaces "ctx: a secp256k1 context object" with "ctx: pointer to a context
   object". Also removes the word "existing".

   aa3dd5280b
4. 
   real-or-random commented at 5:29 pm on January 4, 2024: contributor

   We often say “a pointer” (instead of just “pointer”) in other places, e.g., all other arguments of secp256k1_ec_pubkey_serialize. I mean, it doesn’t matter too much, but if the point of the PR is to get it consistent, perhaps we should also make this part consistent.
5. real-or-random added the label refactor/smell on Jan 4, 2024
6. real-or-random added the label meta/development on Jan 4, 2024
7. jonasnick cross-referenced this on Jan 4, 2024 from issue Add an experimental schnorr signature adaptor module by ZhePang
8. 
   real-or-random commented at 8:55 am on January 5, 2024: contributor

   git grep -E ":[ ]+a pointer" shows three more occurrences. (Well, wo of them are in contrib/lax_der_parsing.h… Since we anyway converged from the version of this file in Core, I’d replace them too, but either way is good, I guess.)

   ACK mod this nit

9. include: in doc, remove article in front of "pointer" da7bc1b803
10. jonasnick force-pushed on Jan 6, 2024
11. real-or-random approved
12. 
    real-or-random commented at 0:16 am on January 9, 2024: contributor

    ACK da7bc1b803b14274bc1687514e5da6a3e1cd9765
13. real-or-random removed the label meta/development on Jan 9, 2024
14. real-or-random added the label user-documentation on Jan 9, 2024
15. 
    sipa commented at 2:21 pm on January 9, 2024: contributor

    ACK da7bc1b803b14274bc1687514e5da6a3e1cd9765
16. jonasnick merged this on Jan 9, 2024
17. jonasnick closed this on Jan 9, 2024

    ---

Contributors
jonasnick real-or-random sipa

Labels
user-documentation refactor/smell