doc: Misc RPC help fixes #17804

pull MarcoFalke wants to merge 6 commits into bitcoin:master from MarcoFalke:1912-rpcDocFixes changing 5 files +58 −39

MarcoFalke commented at 5:39 PM on December 27, 2019: member
This fixes documentation of the following RPCs:
<!-- Also, it comes with a scripted diff to normalize whitespace and type names. (Previous attempts: [#14601](/bitcoin-bitcoin/14601/) and [#14459](/bitcoin-bitcoin/14459/))
fanquake added the label Docs on Dec 27, 2019
MarcoFalke force-pushed on Dec 27, 2019
DrahtBot commented at 5:55 PM on December 27, 2019: member



The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.



Conflicts

No conflicts as of last run.
MarcoFalke force-pushed on Dec 27, 2019
practicalswift commented at 9:00 PM on December 27, 2019: contributor

Concept ACK: nice cleanups!
MarcoFalke force-pushed on Dec 27, 2019

in src/rpc/blockchain.cpp:1214 in fa8f302c63 outdated

1224 | +            "  \"headers\" : xxxxxx,            (numeric) the current number of headers we have validated\n"
1225 | +            "  \"bestblockhash\" : \"...\",       (string) the hash of the currently best block\n"
1226 | +            "  \"difficulty\" : xxxxxx,         (numeric) the current difficulty\n"
1227 | +            "  \"mediantime\" : xxxxxx,         (numeric) median time for the current best block\n"
1228 | +            "  \"verificationprogress\" : xxxx, (numeric) estimate of verification progress [0..1]\n"
1229 | +            "  \"initialblockdownload\" : xxxx, (boolean) (debug information) estimate of whether this node is in Initial Block Download mode.\n"

kristapsk commented at 9:27 PM on December 27, 2019:

Maybe change "xxxx" to "true|false" here and elsewhere where it's boolean too, as it is in other places?

MarcoFalke commented at 9:46 PM on December 27, 2019:

Done in #17809

in src/rpc/blockchain.cpp:1208 in fa8f302c63 outdated

1218 | -            "  \"pruneheight\": xxxxxx,        (numeric) lowest-height complete block stored (only present if pruning is enabled)\n"
1219 | -            "  \"automatic_pruning\": xx,      (boolean) whether automatic pruning is enabled (only present if pruning is enabled)\n"
1220 | -            "  \"prune_target_size\": xxxxxx,  (numeric) the target size used by pruning (only present if automatic pruning is enabled)\n"
1221 | -            "  \"softforks\": {                (object) status of softforks\n"
1222 | +            "  \"chain\" : \"xxxx\",              (string) current network name (main, test, regtest)\n"
1223 | +            "  \"blocks\" : xxxxxx,             (numeric) the height of the most-work fully-validated chain. The genesis block has height 0\n"

kristapsk commented at 9:31 PM on December 27, 2019:

Numeric uses "n" for numbers and "ttt" for timestamps in other places, maybe change others too instead of "xxx"?

MarcoFalke commented at 9:46 PM on December 27, 2019:

Actually, most of the times are denoted with xxx, not ttt. Anyway, this is fixed in #17809

promag commented at 10:22 PM on December 27, 2019:

Out of curiosity, why is xxxxxx (as well the other "values") necessary? Isn't the type sufficient?

MarcoFalke commented at 12:32 AM on December 28, 2019:

It serves a placeholder for the value in the key-value pair of a json dict

in src/rpc/mining.cpp:157 in fa8f302c63 outdated

 153 | @@ -154,7 +154,7 @@ static UniValue generatetodescriptor(const JSONRPCRequest& request)
 154 |              {"maxtries", RPCArg::Type::NUM, /* default */ "1000000", "How many iterations to try."},
 155 |          },
 156 |          RPCResult{
 157 | -            "[ blockhashes ]     (array) hashes of blocks generated\n"},
 158 | +            "[ blockhashes ]     (json array) hashes of blocks generated\n"},

promag commented at 10:26 PM on December 27, 2019:

👀 this is json-rpc?

MarcoFalke commented at 12:34 AM on December 28, 2019:

Yes, RPC arguments are called this way. Also, most of the RPC results are called this way. This scripted diff adjusts the remaining ones. After #17809 it can be changed to something else with a one-line patch.

promag commented at 10:27 PM on December 27, 2019: member

Concept ACK.
fjahr commented at 4:02 PM on January 2, 2020: member

ACK fa8f302c6354bb41c2e7cbdb3448cc1b91c9a531

Reviewed code and did some selective testing.
DrahtBot added the label Needs rebase on Jan 7, 2020
MarcoFalke force-pushed on Jan 9, 2020
MarcoFalke commented at 4:51 PM on January 9, 2020: member

Rebased due to conflict in scripted-diff. Should be easy to re-ACK
DrahtBot removed the label Needs rebase on Jan 9, 2020
doc: Add missing "optional" to "long" estimaterawfee RPC help
Also, use multi-line for arrays and objects
fa0545901d
doc: Fix syntax error (trailing square bracket) in walletprocesspsbt faff5a60ed
doc: Fix syntax error (trailing square bracket) in finalizepsbt fa9dec7c39
doc: Properly document proxy_randomize_credentials as bool in getnetworkinfo
Also, fix indentation of some fields
fa04cd6cfc
doc: Remove duplicate "comment" from listsinceblock RPC help
Also, properly document all (json object) and (json array)
fab63111be
doc: Use proper RPC help syntax in importmulti fa5c6622c8
MarcoFalke force-pushed on Jan 23, 2020
emilengler commented at 7:37 PM on January 24, 2020: contributor

This fixes documentation of the following RPCs:

Are they generated automatically? If so how? Would like to test it (any link to a script?)
MarcoFalke commented at 8:25 PM on January 24, 2020: member

Are they generated automatically? If so how?

https://github.com/bitcoin-core/bitcoincore.org/tree/master/contrib#rpc-documentation-generation
DrahtBot added the label Needs rebase on Jan 29, 2020
MarcoFalke force-pushed on Jan 29, 2020
MarcoFalke commented at 2:54 PM on January 29, 2020: member

Resolved merge conflict
DrahtBot removed the label Needs rebase on Jan 29, 2020
laanwj commented at 1:54 PM on February 5, 2020: member

ACK fa5c6622c8ecf1954e7177888ad8c97a77b16fb7
laanwj referenced this in commit 712b7d9b47 on Feb 5, 2020
laanwj merged this on Feb 5, 2020
laanwj closed this on Feb 5, 2020
sidhujag referenced this in commit 7ff25466b4 on Feb 9, 2020
sidhujag referenced this in commit 1cc11217e9 on Nov 10, 2020
DrahtBot locked this on Feb 15, 2022

Contributors

Labels

Linked (view graph)

#14459 docs: Consistent type names in RPC help descriptions #14601 [rpc] Descriptions: Consistent arg labels for types 'object', 'array', 'boolean', and 'string'#18380 doc: Remove html comment in PULL_REQUEST_TEMPLATE

doc: Misc RPC help fixes #17804

Conflicts