HomePhabricator

Issue #1865 - Clean up RPC help messages
a6099ef319a7Unpublished

Unpublished Commit ยท Learn More

Repository Importing: This repository is still importing.

Description

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

Details

Provenance
sje <sje3000@gmail.com>Authored on Oct 29 2013, 11:29
Wladimir J. van der Laan <laanwj@gmail.com>Committed on Nov 13 2013, 13:54
schancelPushed on Jan 5 2018, 21:58
schancelPushed on Jan 5 2018, 21:39
schancelPushed on Jan 5 2018, 21:17
Parents
rSTAGING2830a9051d19: Merge pull request #3240 from laanwj/2013_11_rebase_no_wallet
Branches
Unknown
Tags
Unknown

Event Timeline

Wladimir J. van der Laan <laanwj@gmail.com> committed rSTAGINGa6099ef319a7: Issue #1865 - Clean up RPC help messages (authored by sje <sje3000@gmail.com>).Nov 13 2013, 13:54