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

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.
rpc: Add missing newline in RPCResult description fadd99f610
rpc: Document an RPCResult for all calls; Enforce at compile time fac52253f8
MarcoFalke force-pushed on Mar 13, 2020
MarcoFalke commented at 7:38 PM on March 13, 2020: member

Added a commit to fix the nit from #17809 (review)
practicalswift commented at 8:33 PM on March 13, 2020: contributor

Concept ACK: compile-time enforcement is the best type of enforcement! :)
DrahtBot added the label Mining on Mar 13, 2020
DrahtBot added the label RPC/REST/ZMQ on Mar 13, 2020
DrahtBot added the label Wallet on Mar 13, 2020
fanquake removed the label Mining on Mar 13, 2020
fanquake removed the label Wallet on Mar 13, 2020
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:
```
$ clang -v
Apple LLVM version 9.0.0 (clang-900.0.31)
Target: x86_64-apple-darwin18.7.0
Thread model: posix
```
MarcoFalke commented at 2:50 PM on March 15, 2020: member

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

I didn't modify sync at all?!
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)
laanwj commented at 4:34 PM on March 16, 2020: member

Lightly tested ACK fac52253f81a4f0d04b25eb4b6c28d04b85ef10b
laanwj merged this on Mar 16, 2020
laanwj closed this on Mar 16, 2020
MarcoFalke deleted the branch on Mar 16, 2020
sidhujag referenced this in commit adf96919dd on Mar 16, 2020
sidhujag referenced this in commit 27817f5308 on Nov 10, 2020
deadalnix referenced this in commit 29659c3c45 on Jan 8, 2021
DrahtBot locked this on Feb 15, 2022

Contributors

Labels