Skip to content

Commit 46c04d4

Browse files
authored
Merge pull request #68 from SimpleITK/UpdateREADME
Updated PySpellChecker description
2 parents aa21048 + 40727fd commit 46c04d4

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,16 @@ If a word is not found in the dictionaries, we try two additional checks.
3636

3737
The script can also process other file types. With the **'--suffix'**
3838
option, the following file types are available: Python (.py), C/C++
39-
(.c/.cxx), Text (.txt), reStructuredText(.rst), Markdown (.md), Ruby (.ruby),
40-
and Java (.java). Note that reStructuredText files are treated as standard
41-
text. Consequentially, all markup keywords that are not actual words will
42-
need to be added to the additional/exception dictionary.
39+
(.c/.cxx), CSharp (.cs), Text (.txt), reStructuredText(.rst), Markdown (.md),
40+
Ruby (.ruby), R (.R), and Java (.java). Note that reStructuredText files are
41+
treated as standard text. Consequentially, all markup keywords that are not
42+
actual words will need to be added to the additional/exception dictionary.
4343

4444
## Dictionary notes
4545

46-
By default, on Linux and Mac systems, pyenchant uses [GNU aspell](http://aspell.net/)
47-
as the underlying dictionary. The spell checking is case sensitive. While
48-
aspell allows arbitrary characters in a dictionary word, CSC may split up
49-
a word by non-alphanumeric characters. This split can occur if the word
50-
itself is not found in the dictionary.
51-
52-
If a dictionary word has non-alphanumeric characters, CSC prints a warning.
46+
We use [PySpellChecker](https://github.com/barrust/pyspellchecker) as the
47+
underlying spellchecker and its associated default dictionary. Previously we
48+
used the pyenchant package and its default dictionary. The pyenchant package
49+
requires an underlying C library, which is not available on all platforms.
50+
PySpellChecker is a pure Python package and works on all platforms with no
51+
additional dependencies.

0 commit comments

Comments
 (0)