script: bump codespell to 2.2.1, update ignored words and fix spelling #26095

pull jonatack wants to merge 2 commits into bitcoin:master from jonatack:2022-09-14-spelling-updates changing 10 files +17 −15

jonatack commented at 6:24 PM on September 14, 2022: contributor

as well as one in test/lint/lint-locale-dependence.py not seen by the spelling linter.

Can be tested locally by running test/lint/lint-spelling.py on this branch versus on master and by checking the CI linter result.
DrahtBot added the label Docs on Sep 14, 2022
aureleoules commented at 8:03 PM on September 14, 2022: member

I opened #25706 recently to avoid PRs like these but it didn't get much attention. What are your thoughts about it?
jonatack commented at 8:10 PM on September 14, 2022: contributor

I opened #25706 recently to avoid PRs like these but it didn't get much attention. What are your thoughts about it?

That pull wouldn't address all of the changes here; I'm not sure it would catch the one here in the linters, and it wouldn't update the ignored words e.g. removing no-longer-needed ones as done here. Also, some of the fixups here aren't from codespell but I bundled them in. Edit: also periodically updating the codespell version.
brunoerg commented at 10:14 PM on September 14, 2022: contributor

Could you please exemplify the changes in test/lint/spelling.ignore-words.txt? (e.g d575413fb8f8569803ed0050c15be003ef50951c added desig and now this PR removes it)
jonatack commented at 10:36 PM on September 14, 2022: contributor
Could you please exemplify the changes in test/lint/spelling.ignore-words.txt? (e.g d575413 added desig and now this PR removes it)
- the code that you mention in your pull no longer uses desig
- the spelling linter passes without desig
If the linter passes after removing any ignored words, we may as well remove them.
brunoerg commented at 10:41 PM on September 14, 2022: contributor

If the linter passes after removing any ignored words, we may as well remove them.

That was my doubt, but makes sense, thanks! In the future, if we need them again, we can put it back as well.
brunoerg approved
brunoerg commented at 10:42 PM on September 14, 2022: contributor

ACK b3b185ada59d11ee8a395554071da1d538e045a9
MarcoFalke commented at 6:19 AM on September 15, 2022: member

CI fails:

https://cirrus-ci.com/task/4515923582255104?logs=lint#L857
Bump codespell version to 2.2.1 8f2010de6e

Fix issues identified by codespell 2.2.1 and update ignored words

and also fix spelling in test/lint/lint-locale-dependence.py not caught by the
spelling linter and fix up a paragraph we are touching here in test/README.md.

b6a65568df

jonatack force-pushed on Sep 15, 2022
jonatack renamed this:
~~doc: fix spelling identified by codespell and update ignored words~~
script: bump codespell to 2.2.1, update ignored words and fix spelling
on Sep 15, 2022
jonatack commented at 11:08 AM on September 15, 2022: contributor

https://cirrus-ci.com/task/4515923582255104?logs=lint#L857

Thanks @MarcoFalke, bumped the codespell version.
satsie approved
satsie commented at 4:28 PM on September 19, 2022: contributor

ACK b6a65568dfbaf25839858b3114c28c07d8f9a45f

Was able to reproduce the CI errors with my local install of codespell. After bumping the version to 2.2.1, test/lint/lint-spelling.py ran with no errors.

Ran test/lint/lint-spelling.py on master and saw all the warnings that are fixed in this PR.

in src/bench/nanobench.h:861 in b6a65568df

 857 | @@ -858,7 +858,7 @@ class Bench {
 858 |       * @brief Retrieves all benchmark results collected by the bench object so far.
 859 |       *
 860 |       * Each call to run() generates a Result that is stored within the Bench instance. This is mostly for advanced users who want to
 861 | -     * see all the nitty gritty detials.
 862 | +     * see all the nitty gritty details.

MarcoFalke commented at 9:21 AM on September 20, 2022:

this will need to be fixed upstream

MarcoFalke merged this on Sep 20, 2022
MarcoFalke closed this on Sep 20, 2022
jonatack deleted the branch on Sep 20, 2022
sidhujag referenced this in commit c40bff4624 on Sep 20, 2022
bitcoin locked this on Sep 20, 2023

Contributors

Labels