Page MenuHomePhabricator

Merge #14720: rpc: Correctly name arguments
ClosedPublic

Authored by nakihito on Thu, Feb 13, 01:36.

Details

Reviewers
Fabien
Group Reviewers
Restricted Owners Package(Owns No Changed Paths)
Restricted Project
Commits
rABC054899250f31: Merge #14720: rpc: Correctly name arguments
Summary

fa0815c300 rpc: Correctly name arguments (Jon Layton)

Pull request description:

Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`.

The tests should pass with or without the changes in `src`.

Partly stolen from #14459 (More RPC help description fixes by ch4ot1c)

Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c

Backport of Core PR14720
https://github.com/bitcoin/bitcoin/pull/14720/

Test Plan
ninja check
ninja check-functional

./bitcoind
./bitcoin-cli help waitforblockheight
./bitcoin-cli help getblockheader
./bitcoin-cli help pruneblockchain
./bitcoin-cli help getchaintxstats
./bitcoin-cli help scantxoutset
./bitcoin-cli help prioritisetransaction
./bitcoin-cli help getblocktemplate
./bitcoin-cli help addnode
./bitcoin-cli help disconnectnode
./bitcoin-cli help setban
./bitcoin-cli help setnetworkactive
./bitcoin-cli help uptime
./bitcoin-cli help importprunedfunds
./bitcoin-cli help importmulti
./bitcoin-cli help getbalance
./bitcoin-cli help listtransactions

Verify help text

./bitcoin-cli uptime <anything>

Verify this fails with error code -1 and then displays the help message.

Diff Detail

Repository
rABC Bitcoin ABC
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

nakihito created this revision.Thu, Feb 13, 01:36
Owners added a reviewer: Restricted Owners Package.Thu, Feb 13, 01:36
Herald added a reviewer: Restricted Project. · View Herald TranscriptThu, Feb 13, 01:36
teamcity edited the summary of this revision. (Show Details)Thu, Feb 13, 01:36

[Bot Message]
One or more PR numbers were detected in the summary.
Links to those Bitcoin Core PRs have been inserted into the summary for reference.

Fabien accepted this revision.Thu, Feb 13, 09:46
This revision is now accepted and ready to land.Thu, Feb 13, 09:46
This revision was automatically updated to reflect the committed changes.