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.

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

Updated README and added Markdown support #17

Merged
merged 3 commits into from
Feb 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,10 @@ If a word is not found in the dictionaries, we try two additional checks.
...camel-case words such as 'GetArrayFromImage', which would get split into
...'Get', 'Array', 'From', and 'Image'. Camel-case words are very commonly
...used for code elements.

The script can also process other file types. With the **'--suffix'**
option, the following file types are available: Python (.py), C/C++
(.c/.cxx), Text (.txt), reStructuredText(.rst), Markdown (.md), Ruby (.ruby),
and Java (.java). Note that reStructuredText files are treated as standard
text. Consequentially, all markup keywords that are not actual words will
need to be added to the additional/exception dictionary.
6 changes: 6 additions & 0 deletions additional_dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -923,6 +923,7 @@ clientdata
closedness
codebook
codebooks
codespell
codeword
codewords
codimension
Expand Down Expand Up @@ -1165,6 +1166,7 @@ getsizeof
getter
ggplot
gimble
github
globals
gmail
goodbit
Expand Down Expand Up @@ -1560,6 +1562,7 @@ public
putback
pv
py
pyenchant
pyplot
qe
ql
Expand Down Expand Up @@ -1612,6 +1615,7 @@ rot90
royalblue
rshift
rsplit
rst
rstrip
runtime
rval
Expand Down Expand Up @@ -1722,6 +1726,7 @@ superpixel
supersampling
superset
svd
svg
swapaxes
sweepline
switch
Expand Down Expand Up @@ -1885,6 +1890,7 @@ xyz
xz
ymax
ymin
yml
yn
yy
yyy
Expand Down
2 changes: 2 additions & 0 deletions tests/test_codespell.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ def test_codespell(self):
"--verbose",
"--suffix",
".py",
"--suffix",
".md",
"."
]
)
Expand Down