joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-28 10:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Dev Docs: Put RPC Tables In Separate CSS Class

Browse source 
Suggested by Saivann: RPC tables with Name/Type/Presence/Description
format are now in .ntpd CSS class so that we can format them specially.

We also change the style of all dev doc tables to replace bold table
headings (thead) with a double-line border-bottom.  This makes the
theads look less like section headings and prevents us from over-using
bold.

Minor: a Makefile warning message has been made more explicit (also
suggested by Saivann) and another Makefile rule was updated to catch
more broken tables.
This commit is contained in:
David A. Harding 2014-12-30 01:11:26 -05:00
parent b8abfb2dcd
commit 9329c69cf8
No known key found for this signature in database
GPG key ID: 4B29C30FF29EC4B7
83 changed files with 209 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
_includes/ref_core_rpc_intro.md
View file

@ -131,6 +131,7 @@ standard arguments:
| → <br>`method` | string | Required<br>(exactly 1) | The RPC, such as `getbestblockhash`. See the RPC section for a list of available commands
| → <br>`params` | array | Required<br>(exactly 1) | An array containing parameters for the RPC. May be an empty array if allowed by the particular RPC
| → → <br>Parameter | *any* | Optional<br>(0 or more) | A parameter. May be any JSON type allowed by the particular RPC
{:.ntpd}
In table above and in other tables describing JSON-RPC input<!--noref-->
and output<!--noref-->, we use the following formatting
@ -200,6 +201,7 @@ The standard JSON-RPC 1.0 result format is described below:
| → → <br>`code` | number (int) | Required<br>(exactly 1) | The error code as set by the returning function and defined in Bitcoin Core's [rpcprotocol.h][]
| → → <br>`message` | string | Required<br>(exactly 1) | An attempt to describe the problem in human-readable text. May be an empty string (""). Bitcoin Core often returns help text with embedded newline strings ("\n"); `bitcoin-cli` can expand these to actual newlines
| → <br>`id` | string | Required<br>(exactly 1) | The arbitrary string passed in when the RPC was called
{:.ntpd}
For an example of the error output<!--noref-->, here's the result
after passing an invalid address to the `sendtoaddress` RPC