Skip to content

Commit

Permalink
docs: just codespell:ignore (#3397)
Browse files Browse the repository at this point in the history
  • Loading branch information
DimitriPapadopoulos authored Apr 10, 2024
1 parent 289d78e commit b8ecc9b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Inline ignore
-------------

Some situation might require ignoring a specific word in a specific location. This can be achieved by adding a comment in the source code.
You can either ignore a single word or a list of words. The comment should be in the format of ``# codespell:ignore <words>``.
You can either ignore a single word or a list of words. The comment should be in the format of ``codespell:ignore <words>``.
Words should be separated by a comma.

1. ignore specific word:
Expand Down

0 comments on commit b8ecc9b

Please sign in to comment.