rpc: Document an RPCResult for all calls; Enforce at compile time #18346

pull MarcoFalke wants to merge 2 commits into bitcoin:master from MarcoFalke:2003-docAllRpcRes changing 8 files +49 −44
  1. MarcoFalke commented at 7:29 pm on March 13, 2020: member

    This documents the RPC Result (type and description, if applicable) everywhere it was missing. The patch can be reviewed with the git diff option -W/--function-context.

    Also, code won’t compile without having an RPCResult documented.

  2. rpc: Add missing newline in RPCResult description fadd99f610
  3. rpc: Document an RPCResult for all calls; Enforce at compile time fac52253f8
  4. MarcoFalke force-pushed on Mar 13, 2020
  5. MarcoFalke commented at 7:38 pm on March 13, 2020: member
    Added a commit to fix the nit from #17809 (review)
  6. practicalswift commented at 8:33 pm on March 13, 2020: contributor
    Concept ACK: compile-time enforcement is the best type of enforcement! :)
  7. DrahtBot added the label Mining on Mar 13, 2020
  8. DrahtBot added the label RPC/REST/ZMQ on Mar 13, 2020
  9. DrahtBot added the label Wallet on Mar 13, 2020
  10. fanquake removed the label Mining on Mar 13, 2020
  11. fanquake removed the label Wallet on Mar 13, 2020
  12. promag commented at 2:47 pm on March 15, 2020: member

    Tested ACK fac52253f81a4f0d04b25eb4b6c28d04b85ef10b, built and verified listunspent help output.

    BTW, had to #include <string> in sync.h , on osx 10.14.6:

    0$ clang -v
    1Apple LLVM version 9.0.0 (clang-900.0.31)
    2Target: x86_64-apple-darwin18.7.0
    3Thread model: posix
    
  13. MarcoFalke commented at 2:50 pm on March 15, 2020: member

    BTW, had to #include in sync.h , on osx 10.14.6:

    I didn’t modify sync at all?!

  14. promag commented at 2:55 pm on March 15, 2020: member
    I know, just saying that you could add a commit to fix that since this is ready for merge instead of a new PR. Unless you prefer a new PR? (clearly <string> is missing there)
  15. laanwj commented at 4:34 pm on March 16, 2020: member
    Lightly tested ACK fac52253f81a4f0d04b25eb4b6c28d04b85ef10b
  16. laanwj merged this on Mar 16, 2020
  17. laanwj closed this on Mar 16, 2020

  18. MarcoFalke deleted the branch on Mar 16, 2020
  19. sidhujag referenced this in commit adf96919dd on Mar 16, 2020
  20. sidhujag referenced this in commit 27817f5308 on Nov 10, 2020
  21. deadalnix referenced this in commit 29659c3c45 on Jan 8, 2021
  22. DrahtBot locked this on Feb 15, 2022

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2024-11-17 12:12 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me