https://github.com/dave3d/itk-spellcheck

Scripts to spell check ITK's headers
https://github.com/dave3d/itk-spellcheck

Last synced: about 2 months ago
JSON representation

Scripts to spell check ITK's headers

• Host: GitHub
• URL: https://github.com/dave3d/itk-spellcheck
• Owner: dave3d
• License: apache-2.0
• Created: 2023-04-22T00:52:10.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-27T19:39:50.000Z (over 1 year ago)
• Last Synced: 2025-02-09T06:42:17.849Z (3 months ago)
• Language: Shell
• Homepage:
• Size: 14.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

Dave's ITK spell checking code

==============================

These scripts run spell checking on the comments in the ITK codebase.

The main reason for this work has been to improve the quality of the ITK

documentation, which is extracted from those comments.

In particular, the spell checking script checks the C++ header files (.h and

.hxx) of all the classes in Modules sub-directory of ITK, except the

ThirdParty directory.  Also we spell check all code files in the ITK/Examples

sub-directory, since users may view them.  In the examples we check the

.cxx and .py files.

To run the spell checker:

    1. Create a python virtual environment using the 'requirements.txt' file.

    2. Run the 'setup' script to download ITK's codebase, the 'codespell.py'

       script, and SimpleITK's 'additional_dictionary.txt'

    3. Run the 'spell' script that actually performs the spell checking.  The

       voluminous output of the spell checker is written to 'modules.log' and

       'examples.log'.

The main spell checking script, 'codespell.py' comes from the following repo:

    https://github.com/SimpleITK/SimpleITKSpellChecking

    

The file 'itk_dict.txt' contains the dictionary of acceptable words found in

ITK.