You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+21-7Lines changed: 21 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,23 +34,33 @@ Usage
34
34
35
35
For more in depth info please check usage with ``codespell -h``.
36
36
37
-
Some noteworthy flags::
37
+
Some noteworthy flags:
38
+
39
+
::
38
40
39
41
codespell -w, --write-changes
40
42
41
-
The ``-w`` flag will actually implement the changes recommended by codespell. Not running with ``-w`` flag is the same as with doing a dry run. It is recommended to run this with the ``-i`` or ``--interactive`` flag.::
43
+
The ``-w`` flag will actually implement the changes recommended by codespell. Not running with ``-w`` flag is the same as with doing a dry run. It is recommended to run this with the ``-i`` or ``--interactive`` flag.
44
+
45
+
::
42
46
43
47
codespell -I FILE, --ignore-words=FILE
44
48
45
-
The ``-I`` flag can be used for a list of certain words to allow that are in the codespell dictionaries. The format of the file is one word per line. Invoke using: ``codespell -I path/to/file.txt`` to execute codespell referencing said list of allowed words. **Important note:** The list passed to ``-I`` is case-sensitive based on how it is listed in the codespell dictionaries.::
49
+
The ``-I`` flag can be used for a list of certain words to allow that are in the codespell dictionaries. The format of the file is one word per line. Invoke using: ``codespell -I path/to/file.txt`` to execute codespell referencing said list of allowed words. **Important note:** The list passed to ``-I`` is case-sensitive based on how it is listed in the codespell dictionaries.
50
+
51
+
::
46
52
47
53
codespell -L word1,word2,word3,word4
48
54
49
-
The ``-L`` flag can be used to allow certain words that are comma-separated placed immediately after it. **Important note:** The list passed to ``-L`` is case-sensitive based on how it is listed in the codespell dictionaries.::
55
+
The ``-L`` flag can be used to allow certain words that are comma-separated placed immediately after it. **Important note:** The list passed to ``-L`` is case-sensitive based on how it is listed in the codespell dictionaries.
56
+
57
+
::
50
58
51
59
codespell -x FILE, --exclude-file=FILE
52
60
53
-
Ignore whole lines that match those in ``FILE``. The lines in ``FILE`` should match the to-be-excluded lines exactly.::
61
+
Ignore whole lines that match those in ``FILE``. The lines in ``FILE`` should match the to-be-excluded lines exactly.
62
+
63
+
::
54
64
55
65
codespell -S, --skip=
56
66
@@ -61,12 +71,16 @@ Comma-separated list of files to skip. It accepts globs as well. Examples:
61
71
* to skip directories, invoke ``codespell --skip="./src/3rd-Party,./src/Test"``
0 commit comments