#36155 doc: remove json quoting from gettxoutsetinfo and getblockstats cli examples
https://github.com/bitcoin/bitcoin/pull/36155 · · +2/-2 in 1 files, 1 commits · labels: Docs
Goal
- Remove redundant inner quotes from CLI help examples for gettxoutsetinfo and getblockstats
- Reduces visual noise and makes help text easier to read for CLI users
Updates the bitcoin-cli usage examples in gettxoutsetinfo and getblockstats help output to omit redundant inner quotes around blockhash arguments. This follows a previous change that allowed bitcoin-cli to accept arguments as plain strings instead of requiring JSON-escaped strings.
Problem: Help text examples for gettxoutsetinfo and getblockstats retained nested quotation marks that are no longer necessary for CLI users, adding visual noise to example commands.
Category: Documentation (#8 of 9)
P4 · cleanup
- P4 because it is a minor readability cleanup in CLI help text
- The existing examples were already valid, so no broken guidance is fixed
P4 as a minor readability cleanup in CLI examples. The old examples with quotes were still valid, so this fixes no incorrect guidance or broken commands.
Membership: Changes RPC help text examples in src/rpc/blockchain.cpp and carries the Docs label.
Factors: security/stability 0, bug 0, performance 0, user value 1, leverage 0
Category: RPC / REST / ZMQ (#51 of 52)
P4 · cleanup
- P4 because it only updates example strings printed in RPC help output
- Leaves argument handling, dispatch logic, and return types untouched
P4 because it merely tweaks example strings printed by RPC help without touching argument parsing, RPC dispatch, or return types.
Membership: Modifies RPC help text definitions in src/rpc/blockchain.cpp.
Factors: security/stability 0, bug 0, performance 0, user value 1, leverage 0
Reviewability: Ready
- Ready to review
- Trivial two-line documentation update with clean CI and no pending questions
The PR is a trivial two-line documentation update with clean CI and no pending questions.
Author status: active
Resolved concerns:
- sedited noted confusing test instructions in the PR description, which the author subsequently removed.
Agreement: Positive
- Standard commit approval (nervana21)
- PR description clarified to remove confusing test notes upon request (sedited)
Positive: ACK from nervana21; PR description clarified per sedited's request.
One contributor provided an ACK, and the only other reviewer comment regarding the PR description text was promptly resolved.
- nervana21 provided a clean commit ACK.
- sedited requested removing confusing test instructions from the description, which csjones addressed.
Review verdicts (DrahtBot): 1
- ACK: nervana21
Files
0 lines under test/bench/ci.
- src/rpc/blockchain.cpp +2/-2
Card
This PR removes unnecessary JSON inner quotes from CLI help examples for gettxoutsetinfo and getblockstats in src/rpc/blockchain.cpp. It follows up on prior work that allowed CLI arguments to be passed as raw strings rather than escaped JSON strings. The problem is purely cosmetic, as the existing quoted examples still functioned correctly. The PR has passing CI, an ACK from nervana21, and no dependencies.