docs: Consistent type names in RPC help descriptions #14459

ch4ot1c · 2018-10-10T17:51:03Z

Followup to #14373.

Now, only these appear in description text:

boolean
numeric
string

json array
json array of xs
json object
json object of xs

src/wallet/rpcwallet.cpp

ch4ot1c · 2018-10-11T00:28:20Z

See above comment.

DrahtBot · 2018-10-20T10:03:38Z

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

Conflicts

Reviewers, this pull request conflicts with the following ones:

#14987 (RPCHelpMan: Pass through Result and Examples by MarcoFalke)
#14918 (RPCHelpMan: Check default values are given at compile-time by MarcoFalke)
#14912 ([WIP] External signer support (e.g. hardware wallet) by Sjors)
#14481 (Add P2SH-P2WSH support to listunspent RPC by MeshCollider)
#14021 (Import key origin data through descriptors in importmulti by achow101)
#12911 (wallet: Show fee in results for signrawtransaction* for segwit inputs by kallewoof)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

maflcko · 2018-10-21T02:32:53Z

importprunedfunds has arguments, but they are not listed in the help string. Mind adding them?
uptime takes (and ignores) a dummy argument, whereas it shouldn't. Mind fixing the code to throw when a dummy is provided?

src/rpc/server.cpp

maflcko · 2018-10-21T04:52:25Z

prioritisetransaction has an argument with a space. Mind to replace the space with underscore?
getbalance has an argument name with a opening bracket. Mind to remove those brackets from the name?

src/wallet/rpcdump.cpp

ch4ot1c · 2018-10-21T05:08:10Z

~~prioritisetransaction and getbalance changes are already in the PR.~~

Edit: All above issues by MarcoFalke have been resolved by the latest code having transitioned to RPCHelpMan.

src/zmq/zmqrpc.cpp

-BEGIN VERIFY SCRIPT- git grep -l "Must be one of\\\n" src | xargs sed -i "s/Must be one of\\\n/Must be one of:\\\n/g" -END VERIFY SCRIPT-

-BEGIN VERIFY SCRIPT- git grep -l "[aA]n array" src/rpc src/wallet | xargs sed -i "s/an array/a json array/g" git grep -l "[aA]n array" src/rpc src/wallet | xargs sed -i "s/An array/A json array/g" -END VERIFY SCRIPT-

…object' -BEGIN VERIFY SCRIPT- git grep -l "pair not an object" test/functional/rpc_rawtransaction.py | xargs sed -i "s/pair not an object/pair not a json object/g" -END VERIFY SCRIPT-

ch4ot1c · 2018-12-28T21:28:54Z

Rebased and ready for review @MarcoFalke. Let me know how you'd like this squashed.

…lockchain.cpp -BEGIN VERIFY SCRIPT- git grep -l "of numeric" src/rpc/blockchain.cpp | xargs sed -i "s/of numeric/of numerics/g" -END VERIFY SCRIPT-

… src/rpc, src/wallet -BEGIN VERIFY SCRIPT- git grep -l "(object) " src/wallet src/rpc | xargs sed -i "s/(object) /(json object) /g" -END VERIFY SCRIPT-

laanwj · 2019-01-14T16:43:56Z

Concept ACK.

Though I think the jargon switch to numeric loses information.

The code, in practice, makes a difference between numeric (in general) and integer. For example where get_int is used, only an integer will be accepted. Not a decimal value with a point.

DrahtBot · 2019-01-29T15:39:00Z

Needs rebase

fa5c662 doc: Use proper RPC help syntax in importmulti (MarcoFalke) fab6311 doc: Remove duplicate "comment" from listsinceblock RPC help (MarcoFalke) fa04cd6 doc: Properly document proxy_randomize_credentials as bool in getnetworkinfo (MarcoFalke) fa9dec7 doc: Fix syntax error (trailing square bracket) in finalizepsbt (MarcoFalke) faff5a6 doc: Fix syntax error (trailing square bracket) in walletprocesspsbt (MarcoFalke) fa05459 doc: Add missing "optional" to "long" estimaterawfee RPC help (MarcoFalke) Pull request description: This fixes documentation of the following RPCs: * estimaterawfee (hidden) * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/walletprocesspsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/rawtransactions/finalizepsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/network/getnetworkinfo/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/listsinceblock/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/importmulti/ <!-- Also, it comes with a scripted diff to normalize whitespace and type names. (Previous attempts: #14601 and #14459) ACKs for top commit: laanwj: ACK fa5c662 Tree-SHA512: 5a10956e12f8ce23e93a2ce8bafd6cae759d8a21658f79397e3bfce3e4aabd9658bdbd40acde49323dca958a9befee7166654994208c182dd60f483109621e17

fa5c662 doc: Use proper RPC help syntax in importmulti (MarcoFalke) fab6311 doc: Remove duplicate "comment" from listsinceblock RPC help (MarcoFalke) fa04cd6 doc: Properly document proxy_randomize_credentials as bool in getnetworkinfo (MarcoFalke) fa9dec7 doc: Fix syntax error (trailing square bracket) in finalizepsbt (MarcoFalke) faff5a6 doc: Fix syntax error (trailing square bracket) in walletprocesspsbt (MarcoFalke) fa05459 doc: Add missing "optional" to "long" estimaterawfee RPC help (MarcoFalke) Pull request description: This fixes documentation of the following RPCs: * estimaterawfee (hidden) * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/walletprocesspsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/rawtransactions/finalizepsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/network/getnetworkinfo/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/listsinceblock/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/importmulti/ <!-- Also, it comes with a scripted diff to normalize whitespace and type names. (Previous attempts: bitcoin#14601 and bitcoin#14459) ACKs for top commit: laanwj: ACK fa5c662 Tree-SHA512: 5a10956e12f8ce23e93a2ce8bafd6cae759d8a21658f79397e3bfce3e4aabd9658bdbd40acde49323dca958a9befee7166654994208c182dd60f483109621e17

…Normalize type names fad027f scripted-diff: Add missing spaces in RPCResult, Fix type names (MarcoFalke) Pull request description: This makes the rendered diff smaller when the RPCResult is machine generated later on (Previous attempts: bitcoin#14601 and bitcoin#14459) ACKs for top commit: Sjors: ACK fad027f Tree-SHA512: 48afd571b1cd349ca0b29bb444c1c7cda657e07dd96c610d479f931ccd938186aec98e533d0552b5b10afc9a3d7b911359260a49448e8e1106e3647b2c71f3ba

fa5c662 doc: Use proper RPC help syntax in importmulti (MarcoFalke) fab6311 doc: Remove duplicate "comment" from listsinceblock RPC help (MarcoFalke) fa04cd6 doc: Properly document proxy_randomize_credentials as bool in getnetworkinfo (MarcoFalke) fa9dec7 doc: Fix syntax error (trailing square bracket) in finalizepsbt (MarcoFalke) faff5a6 doc: Fix syntax error (trailing square bracket) in walletprocesspsbt (MarcoFalke) fa05459 doc: Add missing "optional" to "long" estimaterawfee RPC help (MarcoFalke) Pull request description: This fixes documentation of the following RPCs: * estimaterawfee (hidden) * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/walletprocesspsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/rawtransactions/finalizepsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/network/getnetworkinfo/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/listsinceblock/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/importmulti/ <!-- Also, it comes with a scripted diff to normalize whitespace and type names. (Previous attempts: bitcoin#14601 and bitcoin#14459) ACKs for top commit: laanwj: ACK fa5c662 Tree-SHA512: 5a10956e12f8ce23e93a2ce8bafd6cae759d8a21658f79397e3bfce3e4aabd9658bdbd40acde49323dca958a9befee7166654994208c182dd60f483109621e17

fa0815c rpc: Correctly name arguments (Jon Layton) Pull request description: Consistently use the same name to describe arguments in the documentation and add a test that uses the name. By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`. The tests should pass with or without the changes in `src`. Partly stolen from bitcoin#14459 (More RPC help description fixes by ch4ot1c) Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c

ch4ot1c force-pushed the fix/rpc-descriptions branch 2 times, most recently from c87240c to b96ba90 Compare October 10, 2018 18:37

fanquake added Docs RPC/REST/ZMQ labels Oct 10, 2018

ch4ot1c force-pushed the fix/rpc-descriptions branch 2 times, most recently from b911140 to 060fc25 Compare October 10, 2018 23:52

promag reviewed Oct 11, 2018

View reviewed changes

src/wallet/rpcwallet.cpp Outdated Show resolved Hide resolved

This was referenced Oct 20, 2018

Rpc help helper class #14502

Closed

Add P2SH-P2WSH support to listunspent RPC #14481

Merged

Add ability to convert solvability info to descriptor #14477

Merged

maflcko reviewed Oct 21, 2018

View reviewed changes

src/rpc/server.cpp Outdated Show resolved Hide resolved

maflcko reviewed Oct 21, 2018

View reviewed changes

src/wallet/rpcdump.cpp Outdated Show resolved Hide resolved

ch4ot1c force-pushed the fix/rpc-descriptions branch from 91ed951 to 9b981dd Compare October 21, 2018 04:59

maflcko reviewed Oct 21, 2018

View reviewed changes

src/zmq/zmqrpc.cpp Outdated Show resolved Hide resolved

ch4ot1c force-pushed the fix/rpc-descriptions branch 3 times, most recently from a7bae21 to e300778 Compare October 22, 2018 01:09

ch4ot1c added 3 commits December 28, 2018 14:21

scripted-diff: [rpc] Descriptions: 'Must be one of' -> 'Must be one of:'

4b69280

-BEGIN VERIFY SCRIPT- git grep -l "Must be one of\\\n" src | xargs sed -i "s/Must be one of\\\n/Must be one of:\\\n/g" -END VERIFY SCRIPT-

scripted-diff: [rpc] Descriptions: 'an array' -> 'a json array'

db51182

-BEGIN VERIFY SCRIPT- git grep -l "[aA]n array" src/rpc src/wallet | xargs sed -i "s/an array/a json array/g" git grep -l "[aA]n array" src/rpc src/wallet | xargs sed -i "s/An array/A json array/g" -END VERIFY SCRIPT-

scripted-diff: [rpc] Tests: 'pair not an object' -> 'pair not a json …

ff7329f

…object' -BEGIN VERIFY SCRIPT- git grep -l "pair not an object" test/functional/rpc_rawtransaction.py | xargs sed -i "s/pair not an object/pair not a json object/g" -END VERIFY SCRIPT-

ch4ot1c force-pushed the fix/rpc-descriptions branch from 6046c78 to ff7329f Compare December 28, 2018 19:23

ch4ot1c added 2 commits December 28, 2018 16:46

scripted-diff: [rpc] Descriptions: 'of numeric' -> 'of numerics' in b…

99ab26b

…lockchain.cpp -BEGIN VERIFY SCRIPT- git grep -l "of numeric" src/rpc/blockchain.cpp | xargs sed -i "s/of numeric/of numerics/g" -END VERIFY SCRIPT-

scripted-diff: [rpc] Descriptions: '(object) ' -> '(json object) ' in…

1e96af5

… src/rpc, src/wallet -BEGIN VERIFY SCRIPT- git grep -l "(object) " src/wallet src/rpc | xargs sed -i "s/(object) /(json object) /g" -END VERIFY SCRIPT-

fanquake changed the title ~~More RPC help description fixes~~ docs: More RPC help description fixes Dec 29, 2018

ch4ot1c changed the title ~~docs: More RPC help description fixes~~ docs: Consistent type names in RPC help descriptions Dec 29, 2018

DrahtBot added the Needs rebase label Jan 29, 2019

fanquake added the Up for grabs label Jun 17, 2019

fanquake closed this Jun 17, 2019

maflcko removed the Up for grabs label Jun 17, 2019

laanwj removed the Needs rebase label Oct 24, 2019

maflcko mentioned this pull request Dec 27, 2019

doc: Misc RPC help fixes #17804

Merged

maflcko mentioned this pull request Feb 9, 2020

scripted-diff: Add missing spaces in RPCResult, Normalize type names #18098

Merged

bitcoin locked as resolved and limited conversation to collaborators Dec 16, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Consistent type names in RPC help descriptions #14459

docs: Consistent type names in RPC help descriptions #14459

ch4ot1c commented Oct 10, 2018 •

edited

Loading

ch4ot1c commented Oct 11, 2018 •

edited

Loading

DrahtBot commented Oct 20, 2018 •

edited

Loading

maflcko commented Oct 21, 2018

maflcko commented Oct 21, 2018 •

edited

Loading

ch4ot1c commented Oct 21, 2018 •

edited

Loading

ch4ot1c commented Dec 28, 2018

laanwj commented Jan 14, 2019

DrahtBot commented Jan 29, 2019

docs: Consistent type names in RPC help descriptions #14459

docs: Consistent type names in RPC help descriptions #14459

Conversation

ch4ot1c commented Oct 10, 2018 • edited Loading

ch4ot1c commented Oct 11, 2018 • edited Loading

DrahtBot commented Oct 20, 2018 • edited Loading

Conflicts

maflcko commented Oct 21, 2018

maflcko commented Oct 21, 2018 • edited Loading

ch4ot1c commented Oct 21, 2018 • edited Loading

ch4ot1c commented Dec 28, 2018

laanwj commented Jan 14, 2019

DrahtBot commented Jan 29, 2019

ch4ot1c commented Oct 10, 2018 •

edited

Loading

ch4ot1c commented Oct 11, 2018 •

edited

Loading

DrahtBot commented Oct 20, 2018 •

edited

Loading

maflcko commented Oct 21, 2018 •

edited

Loading

ch4ot1c commented Oct 21, 2018 •

edited

Loading