wallet: Fix comment grammar in bdb.h #23414
Conversation
|
Good catch! |
jarolrod
left a comment
jarolrod
left a comment
There was a problem hiding this comment.
While this is a grammatical error, PR's like this can be seen as spam. I'd advice that as a new contributor you get started on Good First Issues and read up on CONTRIBUTING.md
src/wallet/bdb.h
Outdated
There was a problem hiding this comment.
If you're going to take fix grammar, then technically this should be changed as well
| /** Indicate that a new database user has began using the database. */ | |
| /** Indicate that a new database user has begun using the database. */ |
There was a problem hiding this comment.
Their is a subtle difference , correcting “began” to “begun” really does not impact how you understand the underlying code . “The a new database” makes it looks like their is a class or method called “the a new database “
There was a problem hiding this comment.
Regarding changing began to begun, AFAIK it is more so about not having to open a future PR to address the grammar in this comment again. Hence, I'd suggest you tackle it all in this PR.
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsReviewers, this pull request conflicts with the following ones:
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. |
Zero-1729
left a comment
Zero-1729
left a comment
There was a problem hiding this comment.
Concept ACK
Might I also suggest renaming the PR title to something more specific, perhaps 'wallet: fixed comment grammar in bdb.h'.
Yes. Thanks for trying to contribute, but there's significant overhead in the discussion of PRs, so using them to discuss a single-word change is wasteful. If you want more appreciation for your work I'd recommend looking into fixing bugs and other open issues instead of comment minutea. That said, as this does fix the interpretation of the sentence (and is not just an obvious typo), I'm leaving this open. |
|
Please also fix the other typo. Otherwise we'll have to deal with another pull request touching the same line soon |
laanwj
changed the title
|
Please squash your commits. |
|
Applied the fixes as suggested . Thanks everyone |
|
Please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits |
Wallet: Fixed Grammatical error in bdb.h
|
commit has been squashed as said . |
bd9c6ad wallet: Fixed Grammatical error in bdb.h (zealsham) Pull request description: A comment in bdb.h file in the wallet directory contains a grammatical error that makes the underlying code harder to reason about . The comment which says `/** Indicate the a new database user has began using the database. */` should actually be `/** indicate that a new database user has began using the database. */`. The former is quite confusing , and leaves you wondering what "the a new database user " is refering to . This pull request thus provides value to the bitcoin codebase by improving readability . Top commit has no ACKs. Tree-SHA512: db07cda39f89ac344be3497c884a8c6e4b48276afae18e931a9a8e5732c58eed20645ccd18d6b1212c763f64b1300477c1de26a00b5b3b24e6141ffae3658ca7
bd9c6ad wallet: Fixed Grammatical error in bdb.h (zealsham) Pull request description: A comment in bdb.h file in the wallet directory contains a grammatical error that makes the underlying code harder to reason about . The comment which says `/** Indicate the a new database user has began using the database. */` should actually be `/** indicate that a new database user has began using the database. */`. The former is quite confusing , and leaves you wondering what "the a new database user " is refering to . This pull request thus provides value to the bitcoin codebase by improving readability . Top commit has no ACKs. Tree-SHA512: db07cda39f89ac344be3497c884a8c6e4b48276afae18e931a9a8e5732c58eed20645ccd18d6b1212c763f64b1300477c1de26a00b5b3b24e6141ffae3658ca7
8 participants
A comment in bdb.h file in the wallet directory contains a grammatical error that makes the underlying code harder to reason about .
The comment which says
/** Indicate the a new database user has began using the database. */should actually be/** indicate that a new database user has began using the database. */. The former is quite confusing , and leaves you wondering what "the a new database user " is refering to . This pull request thus provides value to the bitcoin codebase by improving readability .