[rpc] Descriptions: Consistent arg labels for types ‘object’, ‘array’, ‘boolean’, and ‘string’ #14601

1. 
   ch4ot1c commented at 2:59 pm on October 29, 2018: contributor

   Followup for #14459. See scripted-diff: commit messages for scripts used.
2. ch4ot1c force-pushed on Oct 29, 2018
3. ch4ot1c force-pushed on Oct 29, 2018
4. in src/rpc/mining.cpp:894 in 707854f3bb outdated

   892             "          \"inmempool\" : x.x,      (numeric) current number of txs in mempool in the feerate range unconfirmed for at least target blocks\n"
   893             "          \"leftmempool\" : x.x,    (numeric) number of txs over history horizon in the feerate range that left mempool unconfirmed after target\n"
   894             "      },\n"
   895-            "      \"fail\" : { ... },       (json object, optional) information about the highest range of feerates to fail to meet the threshold\n"
   896+            "      \"fail\" : { ... },       (object, optional) information about the highest range of feerates to fail to meet the threshold\n"
   897             "      \"errors\":  [ str... ]   (json array of strings, optional) Errors encountered during processing\n"
   

   ---

   ---

   

   MarcoFalke commented at 3:18 pm on October 29, 2018:

   Could remove the json here as well?
5. 
   MarcoFalke commented at 3:24 pm on October 29, 2018: member

   Concept ACK on making this consistent. Later improvements to make the documentation machine generated would be easier to review.

   I don’t have an opinion on the actual type name, but it should be consistent.

6. MarcoFalke added the label Docs on Oct 29, 2018
7. ch4ot1c force-pushed on Oct 29, 2018
8. ch4ot1c renamed this:
   [rpc] Descriptions: Consistent arg labels for types 'object' and 'boolean'
   [rpc] Descriptions: Consistent arg labels for types 'object', 'array', 'boolean', and 'string'
   on Oct 29, 2018
9. 
   DrahtBot commented at 5:04 pm on October 29, 2018: 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:

   • #14796 (rpc: Pass argument descriptions to RPCHelpMan by MarcoFalke)
   • #14707 ([RPC] Include coinbase transactions in receivedby RPCs by andrewtoth)
   • #14481 (Add P2SH-P2WSH support to listunspent RPC by MeshCollider)
   • #13756 (wallet: “avoid_reuse” wallet flag for improved privacy by kallewoof)
   • #12911 (wallet: Show fee in results for signrawtransaction* for segwit inputs by kallewoof)

   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.

10. MarcoFalke added the label RPC/REST/ZMQ on Nov 14, 2018
11. ch4ot1c force-pushed on Nov 25, 2018
12. DrahtBot added the label Needs rebase on Nov 27, 2018
13. scripted-diff: [rpc] Descriptions: Consistent arg labels for types 'object' and 'boolean'

    -BEGIN VERIFY SCRIPT-
    
    git grep -l "(bool) " src | xargs sed -i "s/(bool) /(boolean) /g"
    git grep -l "(bool, " src/rpc | xargs sed -i "s/(bool, /(boolean, /g"
    git grep -l "(bool, " src/wallet | xargs sed -i "s/(bool, /(boolean, /g"
    
    git grep -l "(json object) " src | xargs sed -i "s/(json object) /(object) /g"
    git grep -l "(json object, " src | xargs sed -i "s/(json object, /(object, /g"
    
    git grep -l "(json array" src | xargs sed -i "s/(json array/(array/g"
    git grep -l "of json objects" src | xargs sed -i "s/of json objects/of objects/g"
    
    -END VERIFY SCRIPT-

    491f0dda96
14. scripted-diff: [rpc] Descriptions: Pluralize 'string' when used in 'array'

    -BEGIN VERIFY SCRIPT-
    
    git grep -l "of string)" src | xargs sed -i "s/of string)/of strings)/g"
    
    -END VERIFY SCRIPT-

    cd5fb6f751
15. ch4ot1c force-pushed on Nov 29, 2018
16. DrahtBot removed the label Needs rebase on Nov 29, 2018
17. 
    DrahtBot commented at 4:53 pm on December 5, 2018: member
18. DrahtBot added the label Needs rebase on Dec 5, 2018
19. 
    MarcoFalke commented at 6:39 pm on December 5, 2018: member

    Needs rebase, but should be simple for a scripted-diff. Also note that RPCHelpMan uses “json array” and “json object”, as opposed to just “object”/“array”.
20. 
    ch4ot1c commented at 5:16 pm on December 14, 2018: contributor

    Closing in favor of #14459.
21. ch4ot1c closed this on Dec 14, 2018

    ---

22. laanwj removed the label Needs rebase on Oct 24, 2019
23. laanwj referenced this in commit 712b7d9b47 on Feb 5, 2020
24. sidhujag referenced this in commit 7ff25466b4 on Feb 9, 2020
25. MarcoFalke referenced this in commit 263f53e2d0 on Feb 17, 2020
26. sidhujag referenced this in commit 1cc11217e9 on Nov 10, 2020
27. DrahtBot locked this on Dec 16, 2021

Contributors
ch4ot1c MarcoFalke DrahtBot

Labels
Docs RPC/REST/ZMQ