diff options
| author | sje <sje3000@gmail.com> | 2013-10-29 22:29:44 +1100 |
|---|---|---|
| committer | Wladimir J. van der Laan <laanwj@gmail.com> | 2013-11-13 14:54:29 +0100 |
| commit | a6099ef319a73e2255dca77065600abb22c4f5f8 (patch) | |
| tree | 4b02c150d44351ceac018a0557667f242ea68f22 /pkg.m4 | |
| parent | 2830a9051d19fa8ba29e26ef0440107a13b15975 (diff) | |
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
Diffstat (limited to 'pkg.m4')
0 files changed, 0 insertions, 0 deletions