Rebased (and pulltester-fixed) version of #3184
Clean up RPC help messages (rebased) #3246
pull laanwj wants to merge 1 commits into bitcoin:master from laanwj:2013_11_rpc_help changing 8 files +1350 −196-
laanwj commented at 1:55 PM on November 13, 2013: member
-
a6099ef319
Issue #1865 - Clean up RPC help messages
Based on the proposal, update the help message of rpc methods - strings arguments are in double quotes rather than square brackets - numeric arguments have no quotes (and no default value) - optional parameters are surrounded by round brackets - json arguments are strings but don't use double quotes Added 3 sections for the details - Arguments: lists each argument, it's type, required or not, a default, and a description - Result: The method result, with json format if applicable, type, and a description - Examples: examples calls using bitcoin-cli and curl for json rpc call Problems - maybe this is too verbose - lines might be too long - description are not good or complete - examples may be too much
- laanwj cross-referenced this on Nov 13, 2013 from issue Issue #1865 - Clean up RPC help messages by sje1
-
BitcoinPullTester commented at 2:25 PM on November 13, 2013: none
Automatic sanity-testing: PASSED, see http://jenkins.bluematt.me/pull-tester/a6099ef319a73e2255dca77065600abb22c4f5f8 for binaries and test log. This test script verifies pulls every time they are updated. It, however, dies sometimes and fails to test properly. If you are waiting on a test, please check timestamps to verify that the test.log is moving at http://jenkins.bluematt.me/pull-tester/current/ Contact BlueMatt on freenode if something looks broken.
- laanwj referenced this in commit 194aa6cfdf on Nov 13, 2013
- laanwj merged this on Nov 13, 2013
- laanwj closed this on Nov 13, 2013
- laanwj cross-referenced this on Nov 13, 2013 from issue Clean up RPC help messages by gavinandresen
- laanwj deleted the branch on Apr 9, 2014
- conscott cross-referenced this on Mar 23, 2018 from issue doc: Remove field in getblocktemplate help that has never been used. by conscott
- MarcoFalke referenced this in commit 10b9a811b6 on Jul 22, 2018
- Bushstar referenced this in commit fd94e9c38c on Apr 8, 2020
- Bushstar referenced this in commit c82e433913 on Apr 8, 2020
- bitcoin locked this on Sep 8, 2021
