Skip to content

Commit fa05459

Browse files
author
MarcoFalke
committed
doc: Add missing "optional" to "long" estimaterawfee RPC help
Also, use multi-line for arrays and objects
1 parent 7a311fa commit fa05459

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

src/rpc/mining.cpp

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -908,7 +908,7 @@ static UniValue estimaterawfee(const JSONRPCRequest& request)
908908
" lower buckets."},
909909
},
910910
RPCResult{
911-
"{\n"
911+
"{ (json object) Results are returned for any horizon which tracks blocks up to the confirmation target\n"
912912
" \"short\" : { (json object, optional) estimate for short time horizon\n"
913913
" \"feerate\" : x.x, (numeric, optional) estimate fee rate in " + CURRENCY_UNIT + "/kB\n"
914914
" \"decay\" : x.x, (numeric) exponential decay (per block) for historical moving average of confirmation data\n"
@@ -921,14 +921,22 @@ static UniValue estimaterawfee(const JSONRPCRequest& request)
921921
" \"inmempool\" : x.x, (numeric) current number of txs in mempool in the feerate range unconfirmed for at least target blocks\n"
922922
" \"leftmempool\" : x.x, (numeric) number of txs over history horizon in the feerate range that left mempool unconfirmed after target\n"
923923
" },\n"
924-
" \"fail\" : { ... }, (json object, optional) information about the highest range of feerates to fail to meet the threshold\n"
925-
" \"errors\": [ str... ] (json array of strings, optional) Errors encountered during processing\n"
924+
" \"fail\" : { (json object, optional) information about the highest range of feerates to fail to meet the threshold\n"
925+
" ...\n"
926+
" },\n"
927+
" \"errors\": [ (json array, optional) Errors encountered during processing\n"
928+
" \"str\", (string)\n"
929+
" ...\n"
930+
" ],\n"
931+
" },\n"
932+
" \"medium\" : { (json object, optional) estimate for medium time horizon\n"
933+
" ...\n"
934+
" },\n"
935+
" \"long\" : { (json object, optional) estimate for long time horizon\n"
936+
" ...\n"
926937
" },\n"
927-
" \"medium\" : { ... }, (json object, optional) estimate for medium time horizon\n"
928-
" \"long\" : { ... } (json object) estimate for long time horizon\n"
929938
"}\n"
930939
"\n"
931-
"Results are returned for any horizon which tracks blocks up to the confirmation target.\n"
932940
},
933941
RPCExamples{
934942
HelpExampleCli("estimaterawfee", "6 0.9")

0 commit comments

Comments
 (0)