Consistency fixes for RPC descriptions #14373

1. 
   ch4ot1c commented at 8:16 pm on October 2, 2018: contributor
2. in src/rpc/blockchain.cpp:512 in 25cc47c8f4 outdated

   508@@ -509,17 +509,17 @@ static UniValue getmempoolancestors(const JSONRPCRequest& request)
   509 {
   510     if (request.fHelp || request.params.size() < 1 || request.params.size() > 2) {
   511         throw std::runtime_error(
   512-            "getmempoolancestors txid (verbose)\n"
   513+            "getmempoolancestors txid ( verbose )\n"
   

   ---

   ---

   

   practicalswift commented at 8:50 pm on October 2, 2018:

   What is the original rationale behind the spacing in ( verbose )?

   ---

   

   ch4ot1c commented at 9:03 pm on October 2, 2018:

   Unsure. Maybe to differentiate it from other normal options. It was also done with ( verbosity ), so I matched it.
3. fanquake added the label RPC/REST/ZMQ on Oct 2, 2018
4. 
   jimmysong commented at 4:20 am on October 3, 2018: contributor

   It would be nice to get all the capitalizations consistent as well. Sometimes the description for a hash result will say “The block hash” others will say “the block hash”.
5. 
   MarcoFalke commented at 4:33 am on October 3, 2018: member

   The formatting fixes would be more elegantly solved with a helper class that takes care of the formatting: See #14378
6. 
   DrahtBot commented at 6:57 am on October 4, 2018: member

   Coverage	Change (pull 14373)	Reference (master)
   Lines	-0.0463 %	87.0471 %
   Functions	+0.0000 %	84.1130 %
   Branches	-0.0322 %	51.5403 %

7. 
   ch4ot1c commented at 8:11 pm on October 7, 2018: contributor

   Also:

   • First letter capitalization consistency
   • Final . consistency

   should be added to the docgen / its checker

8. 
   fanquake commented at 7:13 am on October 9, 2018: member

   Please squash your commits, and we can merge this in. Moving forward we’re likely to be generating this kind of documentation, so that styling can remain consistent.
9. ch4ot1c force-pushed on Oct 9, 2018
10. [rpc] Descriptions: Textual consistency fixes

    'Must be one of' should always end in a ':'
    
    'hex encoded' is now always 'hex-encoded'
    
    Remove redundant '(defaults to CONSERVATIVE)' text from estimatesmartfee
    
    Consistent spacing for options '( verbose )' and '( verbosity )'
    
    'BIP125 replaceable' is now always 'BIP125-replaceable'
    
    JSON-RPC example is now always 'As a JSON-RPC call'

    b8edb9810a
11. ch4ot1c force-pushed on Oct 9, 2018
12. 
    ch4ot1c commented at 1:44 pm on October 9, 2018: contributor

    Squashed
13. 
    fanquake commented at 0:44 am on October 10, 2018: member

    utACK b8edb98
14. 
    meshcollider commented at 1:00 am on October 10, 2018: contributor

    utACK https://github.com/bitcoin/bitcoin/pull/14373/commits/b8edb9810a699015e997e2098dddb2a6cfacbed6
15. 
    promag commented at 1:05 am on October 10, 2018: member

    It would be nice to have a plan for this consistency/cleanup/format etc. There is nothing in place to prevent adding the same inconsistencies. As it is I’m -0.
16. 
    meshcollider commented at 1:25 am on October 10, 2018: contributor

    @promag: @achow101 is working on auto-generated help texts for the RPCs so there is a plan in place for the future, this should be the last RPC help text change before that is done
17. 
    Sjors commented at 2:29 am on October 10, 2018: member

    utACK b8edb98 @promag this seems like a strict improvement even without a plan. However I wouldn’t want to review these kinds of pull requests too often, so looking forward to @achow101’s work.
18. fanquake added this to the "Mergeable" column in a project

    ---

19. MarcoFalke merged this on Oct 10, 2018
20. MarcoFalke closed this on Oct 10, 2018

    ---

21. MarcoFalke referenced this in commit be992701b0 on Oct 10, 2018
22. 
    promag commented at 10:59 am on October 10, 2018: member

    Alrighty then 👍
23. 
    promag commented at 11:58 am on October 10, 2018: member

    Missed "listtransactions (dummy count skip include_watchonly)\n"?
24. fanquake removed this from the "Mergeable" column in a project

    ---

25. deadalnix referenced this in commit 9d64eabb34 on Mar 20, 2020
26. ftrader referenced this in commit 72a527512d on May 19, 2020
27. Munkybooty referenced this in commit 6c654d07a2 on Jul 21, 2021
28. Munkybooty referenced this in commit 8b9438c406 on Jul 21, 2021
29. Munkybooty referenced this in commit 6862fe4031 on Jul 22, 2021
30. Munkybooty referenced this in commit 938be4b3eb on Jul 22, 2021
31. Munkybooty referenced this in commit 2284dd01a2 on Jul 23, 2021
32. DrahtBot locked this on Sep 8, 2021

Contributors
ch4ot1c practicalswift jimmysong MarcoFalke DrahtBot fanquake meshcollider promag Sjors

Labels
RPC/REST/ZMQ