Skip to content

Commit fd5843e

Browse files
committed
Fixup various formatting inconsistencies with RPC help output
1 parent 2dd232d commit fd5843e

File tree

3 files changed

+16
-9
lines changed

3 files changed

+16
-9
lines changed

src/rpc/mining.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -324,15 +324,15 @@ UniValue prioritisetransaction(const JSONRPCRequest& request)
324324
{
325325
if (request.fHelp || request.params.size() != 3)
326326
throw std::runtime_error(
327-
"prioritisetransaction <txid> <priority delta> <fee delta>\n"
327+
"prioritisetransaction \"txid\" priority_delta fee_delta\n"
328328
"Accepts the transaction into mined blocks at a higher (or lower) priority\n"
329329

330330
"\nArguments:\n"
331331
"1. \"txid\" (string, required) The transaction id.\n"
332-
"2. priority delta (numeric, required) The priority to add or subtract.\n"
332+
"2. priority_delta (numeric, required) The priority to add or subtract.\n"
333333
" The transaction selection algorithm considers the tx as it would have a higher priority.\n"
334334
" (priority of a transaction is calculated: coinage * value_in_upiv / txsize) \n"
335-
"3. fee delta (numeric, required) The fee value (in upiv) to add (or subtract, if negative).\n"
335+
"3. fee_delta (numeric, required) The fee value (in upiv) to add (or subtract, if negative).\n"
336336
" The fee is not actually paid, only the algorithm for selecting transactions into a block\n"
337337
" considers the transaction as it would have paid a higher (or lower) fee.\n"
338338

src/rpc/misc.cpp

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -548,8 +548,8 @@ UniValue verifymessage(const JSONRPCRequest& request)
548548

549549
"\nArguments:\n"
550550
"1. \"pivxaddress\" (string, required) The pivx address to use for the signature.\n"
551-
"2. \"signature\" (string, required) The signature provided by the signer in base 64 encoding (see signmessage).\n"
552-
"3. \"message\" (string, required) The message that was signed.\n"
551+
"2. \"signature\" (string, required) The signature provided by the signer in base 64 encoding (see signmessage).\n"
552+
"3. \"message\" (string, required) The message that was signed.\n"
553553

554554
"\nResult:\n"
555555
"true|false (boolean) If the signature is verified or not.\n"
@@ -604,7 +604,7 @@ UniValue setmocktime(const JSONRPCRequest& request)
604604
"\nSet the local time to given timestamp (-regtest only)\n"
605605

606606
"\nArguments:\n"
607-
"1. timestamp (integer, required) Unix seconds-since-epoch timestamp\n"
607+
"1. timestamp (numeric, required) Unix seconds-since-epoch timestamp\n"
608608
" Pass 0 to go back to using the system time.");
609609

610610
if (!Params().IsRegTestNet())
@@ -646,16 +646,23 @@ UniValue logging(const JSONRPCRequest& request)
646646
{
647647
if (request.fHelp || request.params.size() > 2) {
648648
throw std::runtime_error(
649-
"logging [include,...] <exclude>\n"
649+
"logging [include,...] ( [exclude,...] )\n"
650650
"Gets and sets the logging configuration.\n"
651651
"When called without an argument, returns the list of categories that are currently being debug logged.\n"
652652
"When called with arguments, adds or removes categories from debug logging.\n"
653653
"The valid logging categories are: " + ListLogCategories() + "\n"
654654
"libevent logging is configured on startup and cannot be modified by this RPC during runtime."
655+
655656
"Arguments:\n"
656657
"1. \"include\" (array of strings) add debug logging for these categories.\n"
657658
"2. \"exclude\" (array of strings) remove debug logging for these categories.\n"
658-
"\nResult: <categories> (string): a list of the logging categories that are active.\n"
659+
660+
"\nResult:\n"
661+
"{ (object): a JSON object of the logging categories that are active.\n"
662+
" \"category\": fEnabled, (key/value) Key is the category name, value is a boolean of it's active state.\n"
663+
" ...,\n"
664+
"}\n"
665+
659666
"\nExamples:\n"
660667
+ HelpExampleCli("logging", "\"[\\\"all\\\"]\" \"[\\\"http\\\"]\"")
661668
+ HelpExampleRpc("logging", "[\"all\"], \"[libevent]\"")

src/rpc/net.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ UniValue setban(const JSONRPCRequest& request)
431431
if (request.fHelp || request.params.size() < 2 ||
432432
(strCommand != "add" && strCommand != "remove"))
433433
throw std::runtime_error(
434-
"setban \"ip(/netmask)\" \"add|remove\" (bantime) (absolute)\n"
434+
"setban \"ip(/netmask)\" \"add|remove\" ( bantime absolute )\n"
435435
"\nAttempts add or remove a IP/Subnet from the banned list.\n"
436436

437437
"\nArguments:\n"

0 commit comments

Comments
 (0)