scripted-diff: Use named args in RPC docs #23703

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:2112-docOptName changing 11 files +199 −199

MarcoFalke commented at 10:56 AM on December 8, 2021: member

Incorrect named args are source of bugs, like #22979.

To allow them being checked by clang-tidy, use a format it can understand.

scripted-diff: Use named args in RPC docs

-BEGIN VERIFY SCRIPT-
 sed -i -e 's|, /\* optional \*/ true,|, /*optional=*/true,|g' $( git grep -l ', /\* optional \*/ true,' )
-END VERIFY SCRIPT-

fa9aaf8694

MarcoFalke added the label Refactoring on Dec 8, 2021
MarcoFalke added the label Docs on Dec 8, 2021
MarcoFalke commented at 10:58 AM on December 8, 2021: member

PSA: Also, please do use /*optional=*/true where needed. It wasted a lot of my time creating a follow-up after literally every merged RPC change to add the missing optional.

Alternatively, please review https://github.com/bitcoin/bitcoin/pull/23083
DrahtBot commented at 11:08 AM on December 8, 2021: 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:
- #23718 (PSBT: hash preimages fields by darosior)
- #23508 (Add getdeploymentinfo RPC by ajtowns)
- #23330 (WIP: [RPC] allow fetching headers by pages by JeremyRubin)
- #22558 (psbt: Taproot fields for PSBT by achow101)
- #22016 (rpc: add period_start to version bits statistics by Sjors)
- #21283 (Implement BIP 370 PSBTv2 by achow101)
- #19888 (rpc, test: Improve getblockstats for unspendables by fjahr)
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.
fanquake approved
fanquake commented at 9:14 AM on December 9, 2021: member

ACK fa9aaf8694c63200ad01fd5659aba4f409b2c3b9 - checked clang-tidy and it's fine here, (but throwing errors in other files. i.e wallet/test/wallet_tests.cpp).
fanquake merged this on Dec 9, 2021
fanquake closed this on Dec 9, 2021
MarcoFalke deleted the branch on Dec 9, 2021
sidhujag referenced this in commit 2f6d771799 on Dec 10, 2021
RandyMcMillan referenced this in commit 08bb24518b on Dec 23, 2021
DrahtBot locked this on Dec 9, 2022

Contributors

Labels

Linked (view graph)

#22979 doc: Fix walletdisplayaddress RPC doc

scripted-diff: Use named args in RPC docs #23703

Conflicts