wallet: Fix comment grammar in bdb.h #23414

pull zealsham wants to merge 1 commits into bitcoin:master from zealsham:wallet-fix changing 1 files +1 −1

zealsham commented at 1:15 AM on November 2, 2021: contributor

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 .
DrahtBot added the label Wallet on Nov 2, 2021
b3h3rkz commented at 1:32 AM on November 2, 2021: none

Good catch!
in src/wallet/bdb.h:116 in ea5280ad7e outdated
```
 112 | @@ -113,7 +113,7 @@ class BerkeleyDatabase : public WalletDatabase
 113 |       */
 114 |      bool Rewrite(const char* pszSkip=nullptr) override;
 115 |  
 116 | -    /** Indicate the a new database user has began using the database. */
 117 | +    /** Indicate that a new database user has began using the database. */
```
jarolrod commented at 5:14 AM on November 2, 2021:

If you're going to take fix grammar, then technically this should be changed as well

/** Indicate that a new database user has begun using the database. */
zealsham commented at 9:22 AM on November 2, 2021:

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 “

Zero-1729 commented at 4:55 PM on November 2, 2021:

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.
jarolrod commented at 5:15 AM on November 2, 2021: member

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
DrahtBot commented at 10:33 AM on November 2, 2021: 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:
- #20096 (wallet: Remove WalletDatabase refcounting and enforce only one Batch access the database at a time by achow101)
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 commented at 4:55 PM on November 2, 2021: contributor

Concept ACK

Might I also suggest renaming the PR title to something more specific, perhaps 'wallet: fixed comment grammar in bdb.h'.
laanwj commented at 8:52 AM on November 8, 2021: member

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

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.
MarcoFalke commented at 9:04 AM on November 8, 2021: member

Please also fix the other typo. Otherwise we'll have to deal with another pull request touching the same line soon
laanwj renamed this:
~~wallet: Fixed Grammatical error in bdb.h~~
wallet: Fix comment grammar in bdb.h
on Nov 8, 2021
fanquake commented at 11:54 PM on November 8, 2021: member

Please squash your commits.
zealsham commented at 11:54 PM on November 8, 2021: contributor

Applied the fixes as suggested . Thanks everyone
MarcoFalke commented at 8:47 AM on November 9, 2021: member

Please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits
wallet: Fixed Grammatical error in bdb.h
Wallet: Fixed Grammatical error in bdb.h
bd9c6ade46
zealsham force-pushed on Nov 9, 2021
zealsham commented at 11:48 AM on November 9, 2021: contributor

commit has been squashed as said .
laanwj merged this on Nov 9, 2021
laanwj closed this on Nov 9, 2021
sidhujag referenced this in commit e55604b880 on Nov 9, 2021
PastaPastaPasta referenced this in commit a02ea7ec07 on Apr 3, 2022
DrahtBot locked this on Nov 9, 2022

Contributors

Labels

wallet: Fix comment grammar in bdb.h #23414

Conflicts