rpc: Remove redundant types from descriptions #18268

docallag commented at 10:43 AM on March 5, 2020: contributor

Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

fanquake added the label RPC/REST/ZMQ on Mar 5, 2020

in src/rpc/rawtransaction.cpp:360 in 012b3fdc53 outdated

 356 | @@ -357,7 +357,7 @@ static UniValue createrawtransaction(const JSONRPCRequest& request)
 357 |                  "Note that the transaction's inputs are not signed, and\n"
 358 |                  "it is not stored in the wallet or transmitted to the network.\n",
 359 |                  {
 360 | -                    {"inputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "A json array of json objects",
 361 | +                    {"inputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The json objects",

MarcoFalke commented at 1:32 PM on March 5, 2020:

                    {"inputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The inputs",

or just plain empty

in src/wallet/rpcwallet.cpp:2142 in 012b3fdc53 outdated

2138 | @@ -2139,7 +2139,7 @@ static UniValue lockunspent(const JSONRPCRequest& request)
2139 |                  "Also see the listunspent call\n",
2140 |                  {
2141 |                      {"unlock", RPCArg::Type::BOOL, RPCArg::Optional::NO, "Whether to unlock (true) or lock (false) the specified transactions"},
2142 | -                    {"transactions", RPCArg::Type::ARR, /* default */ "empty array", "A json array of objects. Each object the txid (string) vout (numeric).",
2143 | +                    {"transactions", RPCArg::Type::ARR, /* default */ "empty array", "The objects and within each, the txid (string) vout (numeric).",

MarcoFalke commented at 1:34 PM on March 5, 2020:

                    {"transactions", RPCArg::Type::ARR, /* default */ "empty array", "The transaction outputs and within each, the txid (string) vout (numeric).",

in src/wallet/rpcwallet.cpp:4133 in 012b3fdc53 outdated

4129 | @@ -4130,7 +4130,7 @@ UniValue walletcreatefundedpsbt(const JSONRPCRequest& request)
4130 |                  "\nCreates and funds a transaction in the Partially Signed Transaction format. Inputs will be added if supplied inputs are not enough\n"
4131 |                  "Implements the Creator and Updater roles.\n",
4132 |                  {
4133 | -                    {"inputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "A json array of json objects",
4134 | +                    {"inputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The json objects",

MarcoFalke commented at 1:35 PM on March 5, 2020:

                    {"inputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The inputs",

Or just plain empty

in src/wallet/rpcwallet.cpp:4170 in 012b3fdc53 outdated

4166 | @@ -4167,7 +4167,7 @@ UniValue walletcreatefundedpsbt(const JSONRPCRequest& request)
4167 |                              {"includeWatching", RPCArg::Type::BOOL, /* default */ "true for watch-only wallets, otherwise false", "Also select inputs which are watch only"},
4168 |                              {"lockUnspents", RPCArg::Type::BOOL, /* default */ "false", "Lock selected unspent outputs"},
4169 |                              {"feeRate", RPCArg::Type::AMOUNT, /* default */ "not set: makes wallet determine the fee", "Set a specific fee rate in " + CURRENCY_UNIT + "/kB"},
4170 | -                            {"subtractFeeFromOutputs", RPCArg::Type::ARR, /* default */ "empty array", "A json array of integers.\n"
4171 | +                            {"subtractFeeFromOutputs", RPCArg::Type::ARR, /* default */ "empty array", "The integers.\n"

MarcoFalke commented at 1:36 PM on March 5, 2020:

                            {"subtractFeeFromOutputs", RPCArg::Type::ARR, /* default */ "empty array", "The outputs to subtract the fee from.\n"

MarcoFalke approved

DrahtBot commented at 3:29 PM on March 5, 2020: member

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#16377 ([rpc] don't automatically append inputs in walletcreatefundedpsbt by Sjors)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

laanwj commented at 3:30 PM on March 5, 2020: member

ACK after squash

Remove redundant type information from rpc docs

Co-Authored-By: MarcoFalke <falke.marco@gmail.com>

8a2a652e6f

MarcoFalke commented at 3:36 PM on March 5, 2020: member

Please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits

docallag force-pushed on Mar 5, 2020

docallag commented at 3:49 PM on March 5, 2020: contributor

Sorry, thought I'd lost the suggestions from @MarcoFalke but they're all there after the squash. Thanks for those!

MarcoFalke commented at 6:45 PM on March 5, 2020: member

If you want the commit to be attributed to you, you might have to call git commit --amend --author="Name <your@github.email>".

Otherwise, this is good to merge now.

fanquake renamed this:
~~rpcdoc: Remove redundant type from description #18258~~
rpc: Remove redundant types from descriptions
on Mar 5, 2020

laanwj commented at 2:32 PM on March 11, 2020: member

Or alternatively, add the mail that you used for the commit to your github settings, this will make it link to you as well.

Let's merge this immediately after the 0.20 feature freeze if we don't get response from the author.

MarcoFalke added this to the milestone 0.20.0 on Mar 11, 2020

docallag commented at 5:26 PM on March 11, 2020: contributor

Sorry, I didn't realise I had an old email address linked to my Github account. I've updated that now.

MarcoFalke merged this on Mar 11, 2020

MarcoFalke closed this on Mar 11, 2020

sidhujag referenced this in commit e8d4a131bf on Mar 11, 2020

sidhujag referenced this in commit bf7a419f25 on Nov 10, 2020

Fabcien referenced this in commit 0c6b8bbe84 on Jan 7, 2021

DrahtBot locked this on Feb 15, 2022