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

Co-authored-by: Eric Larson <[email protected]> Co-authored-by: Peter Newman <[email protected]> Co-authored-by: bl-ue <[email protected]>
codespell-project · Jun 13, 2021 · 8fb760b · 8fb760b
1 parent 044e6ff
commit 8fb760b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/.github/workflows/codespell-private.yml b/.github/workflows/codespell-private.yml
@@ -33,7 +33,7 @@ jobs:
       - run: python setup.py install
       - run: codespell --help
       - run: make check
-      - run: codespell --check-filenames --skip="./.git/*,*.pyc,./codespell_lib/tests/test_basic.py,./codespell_lib/data/*,./example/code.c,./build/lib/codespell_lib/tests/test_basic.py,./build/lib/codespell_lib/data/*"
+      - run: codespell --check-filenames --skip="./.git/*,*.pyc,./codespell_lib/tests/test_basic.py,./codespell_lib/data/*,./example/code.c,./build/lib/codespell_lib/tests/test_basic.py,./build/lib/codespell_lib/data/*,README.rst,*.egg-info/*"
       # this file has an error
       - run: "! codespell codespell_lib/tests/test_basic.py"
       - run: codecov

diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -13,4 +13,4 @@ jobs:
         with:
           check_filenames: true
           # When using this Action in other repos, the --skip option below can be removed
-          skip: ./.git,./codespell_lib/data,./example/code.c,test_basic.py,*.pyc
+          skip: ./.git,./codespell_lib/data,./example/code.c,test_basic.py,*.pyc,README.rst
diff --git a/README.rst b/README.rst
@@ -3,6 +3,10 @@ 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 should catch errors like
+"adn", but it will not catch "adnasdfasdf". This also means it shouldn't
+generate false-positives when you use a niche term it doesn't know about.
 
 Useful links
 ------------