Skip to content

Commit 6244c20

Browse files
committed
Updated README and added Markdown support
Added a paragraph to the README about supporting other file types and added support for Markdown files. Added some words to the dictionary so that the README.md passes the spell checker.
1 parent f010dce commit 6244c20

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,10 @@ If a word is not found in the dictionaries, we try two additional checks.
3232
...camel-case words such as 'GetArrayFromImage', which would get split into
3333
...'Get', 'Array', 'From', and 'Image'. Camel-case words are very commonly
3434
...used for code elements.
35+
36+
The script can also process other file types. With the **'--suffix'**
37+
option, the following file types are available: Python (.py), C/C++
38+
(.c/.cxx), Text (.txt), reStructuredText(.rst), Markdown (.md), Ruby (.ruby),
39+
and Java (.java). Note that reStructuredText files are treated as standard
40+
text. Consequentially, all markup keywords that are not actual words will
41+
need to be added to the additional/exception dictionary.

additional_dictionary.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -923,6 +923,7 @@ clientdata
923923
closedness
924924
codebook
925925
codebooks
926+
codespell
926927
codeword
927928
codewords
928929
codimension
@@ -1165,6 +1166,7 @@ getsizeof
11651166
getter
11661167
ggplot
11671168
gimble
1169+
github
11681170
globals
11691171
gmail
11701172
goodbit
@@ -1560,6 +1562,7 @@ public
15601562
putback
15611563
pv
15621564
py
1565+
pyenchant
15631566
pyplot
15641567
qe
15651568
ql
@@ -1722,6 +1725,7 @@ superpixel
17221725
supersampling
17231726
superset
17241727
svd
1728+
svg
17251729
swapaxes
17261730
sweepline
17271731
switch
@@ -1885,6 +1889,7 @@ xyz
18851889
xz
18861890
ymax
18871891
ymin
1892+
yml
18881893
yn
18891894
yy
18901895
yyy

0 commit comments

Comments
 (0)