rpc: Document an RPCResult for all calls; Enforce at compile time #18346
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maflcko
force-pushed
the
2003-docAllRpcRes
branch
from
fa36c37 to
fac5225
Compare
Member
Author
|
Added a commit to fix the nit from #17809 (comment) |
Contributor
|
Concept ACK: compile-time enforcement is the best type of enforcement! :) |
promag
reviewed
Mar 15, 2020
Contributor
promag
left a comment
promag
left a comment
There was a problem hiding this comment.
Tested ACK fac5225, 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
Member
Author
I didn't modify |
Contributor
|
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 |
Member
|
Lightly tested ACK fac5225 |
sidhujag
pushed a commit
to syscoin/syscoin
that referenced
this pull request
Mar 16, 2020
…e at compile time fac5225 rpc: Document an RPCResult for all calls; Enforce at compile time (MarcoFalke) fadd99f rpc: Add missing newline in RPCResult description (MarcoFalke) Pull request description: 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. ACKs for top commit: laanwj: Lightly tested ACK fac5225 promag: Tested ACK fac5225, built and verified listunspent help output. Tree-SHA512: af2c1af1432beb944993776026c320814bfaecaf202f47359f5758849096ca7051ec6560395a2cc6678dcc111e7c9cf4917d0f0b221bdcf3ed1642e14d0e5b3c
sidhujag
pushed a commit
to syscoin-core/syscoin
that referenced
this pull request
Nov 10, 2020
…e at compile time fac5225 rpc: Document an RPCResult for all calls; Enforce at compile time (MarcoFalke) fadd99f rpc: Add missing newline in RPCResult description (MarcoFalke) Pull request description: 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. ACKs for top commit: laanwj: Lightly tested ACK fac5225 promag: Tested ACK fac5225, built and verified listunspent help output. Tree-SHA512: af2c1af1432beb944993776026c320814bfaecaf202f47359f5758849096ca7051ec6560395a2cc6678dcc111e7c9cf4917d0f0b221bdcf3ed1642e14d0e5b3c
deadalnix
pushed a commit
to Bitcoin-ABC/bitcoin-abc
that referenced
this pull request
Jan 8, 2021
Summary: Also remove unneeded whitespaces in `rpcwallet.cpp` This is a backport of Core [[bitcoin/bitcoin#18346 | PR18346]] Test Plan: ``` ninja all check-all grep -R ../RPCResults ``` Display the help message for some commands (e.g. `src/bitcoin-cli help getavalanchekey`) Reviewers: #bitcoin_abc, deadalnix Reviewed By: #bitcoin_abc, deadalnix Subscribers: deadalnix Differential Revision: https://reviews.bitcoinabc.org/D8845
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This documents the RPC Result (type and description, if applicable) everywhere it was missing. The patch can be reviewed with the
git diffoption-W/--function-context.Also, code won't compile without having an RPCResult documented.