diff options
author | MarcoFalke <falke.marco@gmail.com> | 2018-12-10 14:02:15 -0500 |
---|---|---|
committer | MarcoFalke <falke.marco@gmail.com> | 2018-12-10 14:02:21 -0500 |
commit | 5f23460c7e316fe7c944680f3feff07ebb867f70 (patch) | |
tree | 98e72243638bca0090fdffdf75f5a576726ab739 /src/rpc/blockchain.cpp | |
parent | 234b99b9210c0a18fca10dfa75331a68f8e74a13 (diff) | |
parent | fa0c24c96e9937f666dcdd83d12145720c7b0329 (diff) | |
download | bitcoin-5f23460c7e316fe7c944680f3feff07ebb867f70.tar.xz |
Merge #14877: rpc: Document default values for optional arguments
fa0c24c96e rpc: Document default values for optional arguments (MarcoFalke)
Pull request description:
Tree-SHA512: e1f5ea67d7ac67526ae87bffaeb308a9ad68632e161fe0148cd431a340bb7a30def18f1dbc7e98c6c1c269ac8942fd5d5334c85c48e4fb1cead70a42536b6eef
Diffstat (limited to 'src/rpc/blockchain.cpp')
-rw-r--r-- | src/rpc/blockchain.cpp | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/src/rpc/blockchain.cpp b/src/rpc/blockchain.cpp index e9a46008d7..ec87f42c93 100644 --- a/src/rpc/blockchain.cpp +++ b/src/rpc/blockchain.cpp @@ -212,11 +212,9 @@ static UniValue waitfornewblock(const JSONRPCRequest& request) "\nWaits for a specific new block and returns useful info about it.\n" "\nReturns the current block on timeout or exit.\n", { - {"timeout", RPCArg::Type::NUM, /* opt */ true, /* default_val */ "", ""}, + {"timeout", RPCArg::Type::NUM, /* opt */ true, /* default_val */ "0", "Time in milliseconds to wait for a response. 0 indicates no timeout."}, }} .ToString() + - "\nArguments:\n" - "1. timeout (int, optional, default=0) Time in milliseconds to wait for a response. 0 indicates no timeout.\n" "\nResult:\n" "{ (json object)\n" " \"hash\" : { (string) The blockhash\n" @@ -1609,7 +1607,7 @@ static UniValue getchaintxstats(const JSONRPCRequest& request) "\nCompute statistics about the total number and rate of transactions in the chain.\n", { {"nblocks", RPCArg::Type::NUM, /* opt */ true, /* default_val */ "one month", "Size of the window in number of blocks"}, - {"blockhash", RPCArg::Type::STR_HEX, /* opt */ true, /* default_val */ "", "The hash of the block that ends the window."}, + {"blockhash", RPCArg::Type::STR_HEX, /* opt */ true, /* default_val */ "chain tip", "The hash of the block that ends the window."}, }} .ToString() + "\nResult:\n" @@ -1743,7 +1741,7 @@ static UniValue getblockstats(const JSONRPCRequest& request) "It won't work without -txindex for utxo_size_inc, *fee or *feerate stats.\n", { {"hash_or_height", RPCArg::Type::NUM, /* opt */ false, /* default_val */ "", "The block hash or height of the target block", "", {"", "string or numeric"}}, - {"stats", RPCArg::Type::ARR, /* opt */ true, /* default_val */ "", "Values to plot, by default all values (see result below)", + {"stats", RPCArg::Type::ARR, /* opt */ true, /* default_val */ "all values", "Values to plot (see result below)", { {"height", RPCArg::Type::STR, /* opt */ true, /* default_val */ "", "Selected statistic"}, {"time", RPCArg::Type::STR, /* opt */ true, /* default_val */ "", "Selected statistic"}, |