doc: fix CI codespell warnings #30700

l0rinc commented at 8:44 PM on August 22, 2024: contributor

Can be checked locally by running test/lint/lint-spelling.py

DrahtBot commented at 8:44 PM on August 22, 2024: contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	jonatack, maflcko

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

DrahtBot added the label Tests on Aug 22, 2024

kevkevinpal commented at 11:22 PM on August 22, 2024: contributor

Can you update the title and commit to start with doc: instead of CI:?

since this is just a doc change

l0rinc renamed this:
~~CI: fix 3 simple codespell warnings~~
doc: fix 3 simple CI codespell warnings
on Aug 23, 2024

maflcko commented at 7:08 AM on August 23, 2024: member

The link in the pull description doesn't work, and can be removed.

Also, you don't need to duplicate the full diff in the pull description.

maflcko commented at 7:08 AM on August 23, 2024: member

lgtm ACK cb89c8dc6a5c3fbcc73b92f4d87433c57b6ed000

in src/test/fuzz/utxo_snapshot.cpp:75 in cb89c8dc6a outdated

  71 | @@ -72,7 +72,7 @@ void utxo_snapshot_fuzz(FuzzBufferType buffer)
  72 |  {
  73 |      FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
  74 |      auto& setup{*g_setup};
  75 | -    bool dirty_chainman{false}; // Re-use the global chainman, but reset it when it is dirty
  76 | +    bool dirty_chainman{false}; // Reuse the global chainman, but reset it when it is dirty

jonatack commented at 7:36 PM on August 24, 2024:

nit, maybe add "re-use" to the ignore list instead; "re-use" doesn't appear to be regarded as incorrect, but rather optional or an Americanism

https://www.oxfordreference.com/display/10.1093/acref/9780195135084.001.0001/acref-9780195135084-e-1902

--- a/test/lint/spelling.ignore-words.txt
+++ b/test/lint/spelling.ignore-words.txt
 outIn
+re-use
 requestor

l0rinc commented at 8:09 PM on August 24, 2024:

We have a few cases of both, but I don't recall seeing it spelled this way anywhere else. My vote goes for fixing them instead of whitelisting.

jonatack commented at 8:42 PM on August 24, 2024:

Yes, I mentioned it because it doesn't need fixing as it's not incorrect, and the linter warning about it will just annoy contributors needlessly.

jonatack commented at 8:54 PM on August 24, 2024:

We already do the same for words in the ignore list like invokable, requestor, unparseable, useable, and warmup. (It looks like "keypair" and "warmup" can be removed from the ignore list now, didn't check all the others.)

l0rinc commented at 10:02 AM on August 25, 2024:

Not sure, in other cases we've just fixed "re-used": https://github.com/bitcoin/bitcoin/pull/28605/files#diff-794891fcb80950b0c81f330c416efdf5d35789fb56a91a18dcc25266d7cdccfdL55

l0rinc commented at 10:06 AM on August 25, 2024:

Lol, seems like everyone is talking about this: https://github.com/codespell-project/codespell/issues/3521

jonatack commented at 4:27 PM on August 28, 2024:

Still hasn't been addressed.

Not sure, in other cases we've just fixed "re-used"

A good guideline would be to use the ignore list when the "fix up" is only to appease an overzealous linter. That avoids needing to re-fix non-issues.

jonatack commented at 4:31 PM on August 28, 2024:

While touching the ignore list, can also remove entries that are no longer needed (mentioned a few above and in other comments).

l0rinc commented at 4:42 PM on August 28, 2024:

Removed the invalid ones and added re-use and incomin

jonatack commented at 7:49 PM on August 24, 2024: member

Missing the following one with current codespell 2.3.0

src/qt/forms/optionsdialog.ui:344: incomin ==> incoming

Perhaps allow "highTS" but not "hights", as the latter could be an misspelling of "heights"

--- a/test/lint/spelling.ignore-words.txt
+++ b/test/lint/spelling.ignore-words.txt
 hashIn
-hights
+highTS
 inflight

l0rinc commented at 8:10 PM on August 24, 2024: contributor

src/qt/forms/optionsdialog.ui:344: incomin ==> incoming

I've seen this one before, it's not a typo and we can't really whitelist it either: incomin&g (I think it means that g is a shortcut key)

jonatack commented at 8:46 PM on August 24, 2024: member

I've seen this one before, it's not a typo and we can't really whitelist it either: incomin&g (I think it means that g is a shortcut key)

Probably preferable to avoid needless warnings when run locally, or in each codespell CI output once updated to a current version.

--- a/test/lint/spelling.ignore-words.txt
+++ b/test/lint/spelling.ignore-words.txt
+incomin
 inflight

l0rinc commented at 10:16 AM on August 25, 2024: contributor

Probably preferable to avoid needless warnings

Since we seem to ignore many other QT related files and folder, I've added this one to the excludes - what do you think?

fanquake commented at 1:17 PM on August 28, 2024: member

The link in the pull description doesn't work, and can be removed. Also, you don't need to duplicate the full diff in the pull description.

Can you update the .. commit to start with doc: instead of CI:?

Did you miss the review feedback here.

l0rinc force-pushed on Aug 28, 2024

l0rinc commented at 3:29 PM on August 28, 2024: contributor

Applied the rest of the suggestions.

fanquake commented at 3:31 PM on August 28, 2024: member

Applied the rest of the suggestions.

You missed this one:

Can you update the .. commit to start with doc: instead of CI:?

l0rinc force-pushed on Aug 28, 2024

l0rinc commented at 3:46 PM on August 28, 2024: contributor

Can you update the .. commit to start with doc: instead of CI:?

done (I interpreted it backwards because of the colons)

in test/lint/lint-spelling.py:17 in faede95bbe outdated

  13 | @@ -14,7 +14,7 @@
  14 |  from lint_ignore_dirs import SHARED_EXCLUDED_SUBTREES
  15 |  
  16 |  IGNORE_WORDS_FILE = 'test/lint/spelling.ignore-words.txt'
  17 | -FILES_ARGS = ['git', 'ls-files', '--', ":(exclude)build-aux/m4/", ":(exclude)contrib/seeds/*.txt", ":(exclude)depends/", ":(exclude)doc/release-notes/", ":(exclude)src/qt/locale/", ":(exclude)src/qt/*.qrc", ":(exclude)contrib/guix/patches"]
  18 | +FILES_ARGS = ['git', 'ls-files', '--', ":(exclude)build-aux/m4/", ":(exclude)contrib/seeds/*.txt", ":(exclude)depends/", ":(exclude)doc/release-notes/", ":(exclude)src/qt/locale/", ":(exclude)src/qt/forms/optionsdialog.ui", ":(exclude)src/qt/*.qrc", ":(exclude)contrib/guix/patches"]

fanquake commented at 4:17 PM on August 28, 2024:

src/qt/forms/optionsdialog.ui

I don't think that adding a single file here, for which we are responsible for the spelling, is correct.

l0rinc commented at 4:23 PM on August 28, 2024:

Otherwise, we would have to whitelist an incorrect word - or can you suggest a better solution?

fanquake commented at 4:26 PM on August 28, 2024:

Whitelisting a word seems fine compared to ignoring the spelling for an entire user-facing settings page.

jonatack commented at 4:28 PM on August 28, 2024:

Agree with @fanquake; better add a word to the ignore list than to exclude the file.

l0rinc commented at 4:29 PM on August 28, 2024:

You'd rather we silence "incomin" everywhere? See: #30700 (comment)

l0rinc force-pushed on Aug 28, 2024

doc: fix a few simple codespell warnings f9a08f35a5

Update spelling.ignore-words

Removed ba, inflight, keypair and warmup.
Added incomin found in optionsdialog.ui:345 and re-use found in utxo_snapshot.cpp

837fbca036

l0rinc force-pushed on Aug 28, 2024

l0rinc renamed this:
~~doc: fix 3 simple CI codespell warnings~~
doc: fix CI codespell warnings
on Aug 28, 2024

fanquake approved

fanquake commented at 4:47 PM on August 28, 2024: member

ack 837fbca03602982d9f1055ac798711241ea3d0a0 ci output looks fine.

in test/lint/spelling.ignore-words.txt:31 in 837fbca036

  27 | @@ -29,5 +28,4 @@ unparseable
  28 |  unser
  29 |  useable
  30 |  viewIn
  31 | -warmup
  32 | -wit
  33 | +wit

jonatack commented at 4:49 PM on August 28, 2024:

nit, \ No newline at end of file

jonatack commented at 4:49 PM on August 28, 2024: member

ACK 837fbca03602982d9f1055ac798711241ea3d0a0

DrahtBot requested review from maflcko on Aug 28, 2024

jonatack commented at 4:50 PM on August 28, 2024: member

Looks like the PR description about "re-use" could be updated. Edit: it has been updated.

maflcko commented at 5:46 AM on August 29, 2024: member

lgtm ACK 837fbca03602982d9f1055ac798711241ea3d0a0

fanquake merged this on Aug 29, 2024

fanquake closed this on Aug 29, 2024

hodlinator referenced this in commit ed313d166b on May 14, 2025

bitcoin locked this on Aug 29, 2025