Add note about not being a general spell checking tool. #1535

tir38 · 2020-05-31T00:34:31Z

I spent way too much time figuring this out the hard way.

peternewman · 2020-05-31T11:08:10Z

Out of interest @tir38 what was missing to make it a general spell checking tool? What makes you think it isn't one?

tir38 · 2020-06-01T19:43:18Z

I tried to test this by just barfing rando text into a file (e.g. asdadaflkjasd) and codespell didn't report this as a mispelling

$ echo "asdfasdf" -> somefile.txt
$ echo "dne" -> someOtherFile.txt
$ codespell
./someOtherFile.txt:1: dne ==> done

larsoner · 2020-06-01T19:52:03Z

It looks for common spelling mistakes rather than membership in a complete dictionary. Maybe it can be rephrased to take this into account?

tir38 · 2020-06-01T19:52:38Z

@larsoner yep, that was what I hoped to accomplish by updating the README

README.rst

Co-authored-by: Eric Larson <[email protected]>

tir38 · 2020-07-14T23:46:18Z

README.rst

@@ -3,6 +3,9 @@ codespell

 Fix common misspellings in text files. It's designed primarily for checking
 misspelled words in source code, but it can be used with other files as well.
+It does not check for word membership in a complete dictionary, but instead
+looks for a set of common misspellings. Therefore it might catch errors like
+"adn", but it will not catch "adnasdfasdf".



Derp. Talk about circular dependency. Using Codespell to check readme of repo finds spelling error, which only exists to show example of spelling error. Not sure if I should fix this.

Well at least we know it's working @tir38 ! Joking apart we could either ignore the line or add the specific typo to an allowed list (although if we do the latter it would be better if it was a more obscure word/less likely typo, but perhaps that defeats the point of the example; abandonned is our goto typo, but it's not as obvious as the example one).

@larsoner Travis didn't catch this as it's only checking the module source stuff, not the surrounding files:
codespell --skip="codespell_lib/tests/test_basic.py,codespell_lib/data/*" codespell_lib/

Feel free to add it to the checks

Done in #1596

See #1535 (comment) for more detail of fixes.

README.rst

peternewman · 2021-02-21T18:30:06Z

Sorry this slipped by the wayside @tir38 . I think it would still make sense to get it in.

To avoid the error it's now trapping (due to #1596), we'll need to skip it, the safest way is probably adding an exclude file into
https://github.com/codespell-project/codespell/blob/master/.github/workflows/codespell.yml
For the syntax, see:
https://github.com/codespell-project/actions-codespell#parameter-exclude_file

peternewman

Sorry this slipped by the wayside @tir38 . I think it would still make sense to get it in, do you want to have a go. I think the following changes should do the trick.

README.rst

peternewman · 2021-02-21T18:34:21Z

README.rst

@@ -3,6 +3,9 @@ codespell

 Fix common misspellings in text files. It's designed primarily for checking
 misspelled words in source code, but it can be used with other files as well.
+It does not check for word membership in a complete dictionary, but instead
+looks for a set of common misspellings. Therefore it might catch errors like
+"adn", but it will not catch "adnasdfasdf".



See #1535 (comment) for more detail of fixes.

Co-authored-by: Peter Newman <[email protected]>

Don't spellcheck README.md

bl-ue

🎉

peternewman

Sorry @bl-ue , we can't just skip the whole of README.rst because of one (deliberate) typo! How daft is codespell going to look when it ships a readme with typos in it?!?

The ideal solution is to check readme separately and ignore just the one or two deliberate typos (via ignore words). The more general solution for other people where it's less critical would be to ignoreit across the entire codebase. We should really use the ideal solution given what we're representing!

peternewman · 2021-06-14T14:12:10Z

Are you happy to re-engineer the CI tests then after this @bl-ue , or do you want me to?

bl-ue · 2021-06-14T17:29:14Z

Sorry @bl-ue , we can't just skip the whole of README.rst because of one (deliberate) typo! How daft is codespell going to look when it ships a readme with typos in it?!?

I'm sorry! That's what we get with my eager merging 😝😆

Are you happy to re-engineer the CI tests then after this @bl-ue , or do you want me to?

You mean update the CI to only ignore the specific typos in the readme? Sure, I'll do it!

peternewman · 2021-06-14T19:22:49Z

I'm sorry! That's what we get with my eager merging stuck_out_tongue_closed_eyeslaughing

😄

Are you happy to re-engineer the CI tests then after this @bl-ue , or do you want me to?

You mean update the CI to only ignore the specific typos in the readme? Sure, I'll do it!

The gold-plated solution would probably be best, skip the readme as you've done in the main run, but add another run which checks just the readme but ignores the additional deliberate typos, then we won't get "adn" all over the rest of the codebase.

bl-ue · 2021-06-14T19:42:44Z

Good idea. I'll do it 👍🏻

Followup to #1535

tir38 · 2021-06-16T16:35:13Z

thanks y'all!

bl-ue · 2021-06-16T16:45:49Z

No problem @tir38 — thank you for evaluating codespell! I'd recommend some other tools that are probably more what you're thinking of when you hear spellchecker:

peternewman · 2021-06-18T00:45:28Z

No problem @tir38 — thank you for evaluating codespell! I'd recommend some other tools that are probably more what you're thinking of when you hear spellchecker:

😆 You're not supposed to plug the competition @bl-ue ! 🤣

bl-ue · 2021-06-18T00:48:30Z

Hahaha — sorry @peternewman! 😂

Add note about not being a general spell checking tool.

1418a97

peternewman added the enhancement label May 31, 2020

larsoner reviewed Jun 1, 2020

View reviewed changes

README.rst Outdated Show resolved Hide resolved

Update README.rst

ec4ae25

Co-authored-by: Eric Larson <[email protected]>

tir38 commented Jul 14, 2020

View reviewed changes

peternewman reviewed Jul 15, 2020

View reviewed changes

README.rst Outdated Show resolved Hide resolved

peternewman mentioned this pull request Jul 16, 2020

Don't report spelling mistakes in HTTP URLs (e.g. in comments) #676

Closed

tir38 closed this Feb 16, 2021

peternewman reopened this Feb 21, 2021

peternewman requested changes Feb 21, 2021

View reviewed changes

peternewman added this to the v2.1.0 milestone May 28, 2021

peternewman modified the milestones: v2.1.0, v2.2.0 Jun 10, 2021

bl-ue and others added 5 commits June 12, 2021 11:16

Apply suggestions from code review

ab91962

Co-authored-by: Peter Newman <[email protected]>

Update codespell.yml

978b998

Don't spellcheck README.md

Merge branch 'master' into add-note-to-readme

d207295

Whoops, .rst not .md

b8551d9

Update codespell-private.yml

d4afe2a

bl-ue approved these changes Jun 12, 2021

View reviewed changes

bl-ue requested a review from peternewman June 12, 2021 16:25

bl-ue merged commit 8fb760b into codespell-project:master Jun 13, 2021

peternewman reviewed Jun 14, 2021

View reviewed changes

bl-ue added a commit that referenced this pull request Jun 14, 2021

MAINT: Ignore deliberate "adn" typo in README.rst

a719c63

Followup to #1535

bl-ue mentioned this pull request Jun 14, 2021

MAINT: Ignore deliberate "adn" typo in README.rst #1976

Closed

tir38 deleted the add-note-to-readme branch June 16, 2021 16:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add note about not being a general spell checking tool. #1535

Add note about not being a general spell checking tool. #1535

tir38 commented May 31, 2020

peternewman commented May 31, 2020

tir38 commented Jun 1, 2020 •

edited

Loading

larsoner commented Jun 1, 2020

tir38 commented Jun 1, 2020

tir38 Jul 14, 2020

peternewman Jul 15, 2020

larsoner Jul 15, 2020

peternewman Jul 15, 2020

peternewman Feb 21, 2021

peternewman commented Feb 21, 2021

peternewman left a comment

peternewman Feb 21, 2021

bl-ue left a comment

peternewman left a comment

peternewman commented Jun 14, 2021

bl-ue commented Jun 14, 2021

peternewman commented Jun 14, 2021

bl-ue commented Jun 14, 2021

tir38 commented Jun 16, 2021

bl-ue commented Jun 16, 2021

peternewman commented Jun 18, 2021

bl-ue commented Jun 18, 2021

Add note about not being a general spell checking tool. #1535

Add note about not being a general spell checking tool. #1535

Conversation

tir38 commented May 31, 2020

peternewman commented May 31, 2020

tir38 commented Jun 1, 2020 • edited Loading

larsoner commented Jun 1, 2020

tir38 commented Jun 1, 2020

tir38 Jul 14, 2020

Choose a reason for hiding this comment

peternewman Jul 15, 2020

Choose a reason for hiding this comment

larsoner Jul 15, 2020

Choose a reason for hiding this comment

peternewman Jul 15, 2020

Choose a reason for hiding this comment

peternewman Feb 21, 2021

Choose a reason for hiding this comment

peternewman commented Feb 21, 2021

peternewman left a comment

Choose a reason for hiding this comment

peternewman Feb 21, 2021

Choose a reason for hiding this comment

bl-ue left a comment

Choose a reason for hiding this comment

peternewman left a comment

Choose a reason for hiding this comment

peternewman commented Jun 14, 2021

bl-ue commented Jun 14, 2021

peternewman commented Jun 14, 2021

bl-ue commented Jun 14, 2021

tir38 commented Jun 16, 2021

bl-ue commented Jun 16, 2021

peternewman commented Jun 18, 2021

bl-ue commented Jun 18, 2021

tir38 commented Jun 1, 2020 •

edited

Loading