Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor typo fix in README #3580

Merged
merged 3 commits into from
Nov 15, 2024
Merged

Minor typo fix in README #3580

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
710acdb
fix incorrect case
DanielYang59 Nov 15, 2024
32f27fa
clarify
DanielYang59 Nov 15, 2024
7837a55
Revert "clarify"
DanielYang59 Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The ``-I`` flag can be used for a list of certain words to allow that are in the

codespell -L word1,word2,word3,word4

The ``-L`` flag can be used to allow certain words that are comma-separated placed immediately after it. See `Ignoring Words`_ for more details.
DanielYang59 marked this conversation as resolved.
Show resolved Hide resolved
The ``-L`` flag can be used to allow certain words that are comma-separated (without spaces). See `Ignoring Words`_ for more details.

.. code-block:: sh

Expand Down Expand Up @@ -119,7 +119,7 @@ You can select the optional dictionaries with the ``--builtin`` option.
Ignoring words
--------------

When ignoring false positives, note that spelling errors are *case-insensitive* but words to ignore are *case-sensitive*. For example, the dictionary entry ``wrod`` will also match the typo ``Wrod``, but to ignore it you must pass ``wrod``.
When ignoring false positives, note that spelling errors are *case-insensitive* but words to ignore are *case-sensitive*. For example, the dictionary entry ``wrod`` will also match the typo ``Wrod``, but to ignore it you must pass ``Wrod``.

The words to ignore can be passed in two ways:

Expand Down