Skip to content

Conversation

@ryanofsky
Copy link
Contributor

No description provided.

…umpfee

Documentation change only, no change in behavior.
@TheBlueMatt
Copy link
Contributor

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.

@ryanofsky
Copy link
Contributor Author

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.

@jonasschnelli
Copy link
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).

@ryanofsky
Copy link
Contributor Author

Ok, I moved details from the RPC help string to a code comment in 5a00659. 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).

@TheBlueMatt
Copy link
Contributor

ACK

@maflcko
Copy link
Member

maflcko commented Jan 25, 2017

ACK 5a00659.

Also assigning 0.14, as this fixes documentation.

@maflcko maflcko added this to the 0.14.0 milestone Jan 25, 2017
@laanwj laanwj merged commit 5a00659 into bitcoin:master Jan 26, 2017
laanwj added a commit that referenced this pull request Jan 26, 2017
…action with bumpfee

5a00659 [wallet] Clarify getbalance help string to explain interaction with bumpfee (Russell Yanofsky)
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants