home :: GitHub - ruby/rdoc-spellcheck: A spellchecker for RDoc
rdoc :: rdoc-spellcheck-1.0 Documentation
bugs :: Issues · ruby/rdoc-spellcheck · GitHub
rdoc-spellcheck checks your documentation for spelling errors. File,
class,
and method names are automatically excluded from the results and you can
add
your own words to the default word list.
=== Features
- Checks documentation for pages, classes, modules, methods, constants,
etc. - Prints a report showing each misspelled word and correction
suggestions
=== Synopsis
$ rdoc -f spellcheck lib *.rdoc
=== Requirements
- rdoc
- libaspell – See
https://github.com/evan/raspell/blob/master/README.rdoc for
installation instructions for aspell
=== Install
sudo gem install rdoc-spellcheck