[wallet] Clarify getbalance help string to explain interaction with bumpfee #9613

1. 
   ryanofsky commented at 3:28 pm on January 23, 2017: member
2. [wallet] Clarify getbalance help string to explain interaction with bumpfee

   Documentation change only, no change in behavior.

   5a00659b58
3. 
   TheBlueMatt commented at 4:26 pm on January 23, 2017: member

   Do we need to describe the implementation details in the docs? I’d prefer something shorter that just nodes “if there are conflicting spends of wallet outputs, these may be counted twice, resulting in an incorrect balance”.

   Related issue: #8183.

4. 
   ryanofsky commented at 5:27 pm on January 23, 2017: member

   I don’t see these as implementation details, I just think this just a basic description of what the two balances represent. I could remove the extra help text and text turn it into a code comment, if there is a reason to thing that more vague documentation would be better here, but I’d be curious to know advantages you think this could have.
5. 
   jonasschnelli commented at 8:17 am on January 24, 2017: contributor

   I had the same impressions like @TheBlueMatt. Is very technical and deeper connects the implementation with the documentation, means, if we change the implementation, we may need to update the docs (or remove which would be a step backwards then).
6. jonasschnelli added the label Wallet on Jan 24, 2017
7. jonasschnelli added the label RPC/REST/ZMQ on Jan 24, 2017
8. ryanofsky force-pushed on Jan 24, 2017
9. 
   ryanofsky commented at 6:38 pm on January 24, 2017: member

   Ok, I moved details from the RPC help string to a code comment in 5a00659b58800ce52b652a31d551a984926c46de. I also added a broader warning about the account parameter since Matt and Alex pointed out that only describing one potential problem might imply that there are no other problems we know about (which apparently there are in #8183, #3816, #7597, #6042).
10. 
    TheBlueMatt commented at 11:30 pm on January 24, 2017: member

    ACK
11. 
    MarcoFalke commented at 1:32 am on January 25, 2017: member

    ACK 5a00659b58800ce52b652a31d551a984926c46de.

    Also assigning 0.14, as this fixes documentation.

12. MarcoFalke added this to the milestone 0.14.0 on Jan 25, 2017
13. laanwj merged this on Jan 26, 2017
14. laanwj closed this on Jan 26, 2017

    ---

15. laanwj referenced this in commit 07421cf2a7 on Jan 26, 2017
16. DrahtBot locked this on Sep 8, 2021

Contributors
ryanofsky TheBlueMatt jonasschnelli MarcoFalke

Labels
Wallet RPC/REST/ZMQ

Milestone
0.14.0