rpc: small description/help improvements in blockchain.cpp #25420

pull MarnixCroes wants to merge 1 commits into bitcoin:master from MarnixCroes:rpc-description-improvements-blockchain changing 1 files +71 −71

MarnixCroes commented at 10:25 AM on June 20, 2022: contributor

To match the other descriptions/help doc -start with Capital -no . at the end -"Use coinstatsindex, if available." -> "Use coinstatsindex (if available)"
description improvements rpc blockchain b8dba51428
fanquake added the label RPC/REST/ZMQ on Jun 20, 2022
DrahtBot commented at 12:06 AM on June 21, 2022: contributor



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



Conflicts

No conflicts as of last run.
MarcoFalke commented at 3:43 PM on June 21, 2022: member

If this is something that should be done, it should be enforced in the rpc help manager.

in src/rpc/blockchain.cpp:301 in b8dba51428

 296 | @@ -297,7 +297,7 @@ static RPCHelpMan waitforblock()
 297 |                  "\nWaits for a specific new block and returns useful info about it.\n"
 298 |                  "\nReturns the current block on timeout or exit.\n",
 299 |                  {
 300 | -                    {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "Block hash to wait for."},
 301 | +                    {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "Block hash to wait for"},
 302 |                      {"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."},

MarcoFalke commented at 5:50 PM on June 23, 2022:

This one has a dot and above you are removing it.

MarcoFalke changes_requested
MarcoFalke commented at 5:51 PM on June 23, 2022: member

I am not sure if this is worth it, given that it is increasing inconsistency?
MarcoFalke commented at 5:52 PM on June 23, 2022: member
Thank you for your contribution. While this stylistic change makes sense on its own, it comes at a cost and risk for the project as a whole. The weak motivation for the change does not justify the burden that it places on the project. A burden could be any of the following:
- Time spent on review
- Accidental introduction of bugs
- (Silent) merge conflicts, either in the branch or a backport branch. Those conflicts demand further developer and reviewer time or introduce bugs.
For more information about refactoring changes and stylistic cleanup, see
Generally, if the style is not mentioned nor enforced by the developer notes, we leave it up to the original author to pick whatever fits them best personally and then leave it that way until the line is touched for other reasons.

Let me know if you have any questions.
MarcoFalke closed this on Jun 23, 2022
bitcoin locked this on Jun 23, 2023
MarnixCroes deleted the branch on Sep 10, 2023

Contributors

Labels

rpc: small description/help improvements in blockchain.cpp #25420

Conflicts