From ce7a2fcc503b454f9b956919482b825785e175a8 Mon Sep 17 00:00:00 2001 From: Dave Chen Date: Fri, 11 Jul 2025 16:14:04 -0400 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4ac6a01..f421ad2 100644 --- a/README.md +++ b/README.md @@ -36,17 +36,15 @@ If a word is not found in the dictionaries, we try two additional checks. 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. +(.c/.cxx), CSharp (.cs), Text (.txt), reStructuredText(.rst), Markdown (.md), +Ruby (.ruby), R (.R), 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. ## Dictionary notes -By default, on Linux and Mac systems, pyenchant uses [GNU aspell](http://aspell.net/) -as the underlying dictionary. The spell checking is case sensitive. While -aspell allows arbitrary characters in a dictionary word, CSC may split up -a word by non-alphanumeric characters. This split can occur if the word -itself is not found in the dictionary. +We use [PySpellChecker](https://github.com/barrust/pyspellchecker) for our +underlying dictionary. Previously we used different package that required an +underlying C library, which was not available on all platforms. +PySpellChecker is pure Python and works on all platforms. -If a dictionary word has non-alphanumeric characters, CSC prints a warning.