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

DOC: Update readme #56

Merged
merged 1 commit into from
Feb 7, 2024
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
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
![python testing](https://github.com/SimpleITK/CommentSpellCheck/actions/workflows/python-app.yml/badge.svg)


A script that automatically spell checks the comments of a code base.
It is intended to be run on the SimpleITK and ITK code bases.
The CommentSpellCheck (CSC) package provides a script that automatically
spell checks the comments of a code base. It was originally developed to
be run on the SimpleITK and ITK code bases.

Here is how it is typically run:

Expand Down Expand Up @@ -39,3 +40,13 @@ option, the following file types are available: Python (.py), C/C++
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.

If a dictionary word has non-alphanumeric characters, CSC prints a warning.
1 change: 1 addition & 0 deletions additional_dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -842,6 +842,7 @@ asarray
ascontiguousarray
asin
asm
aspell
ast
atan
atol
Expand Down
Loading