Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .autotest
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 History.rdoc
Octocat-spinner-32 Manifest.txt
Octocat-spinner-32 README.rdoc
Octocat-spinner-32 Rakefile
README.rdoc

rdoc-spellcheck

home

github.com/rdoc/rdoc-spellcheck

rdoc

docs.seattlerb.org/rdoc-spellcheck

bugs

github.com/rdoc/rdoc-spellcheck/issues

Description

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

Problems

rdoc-spellcheck depends on aspell for which development has ceased despite messages to the contrary. I've submitted two pull requests to the hunspell-ffi gem that should allow it to become a usable replacement for the raspell gem. (The currently released hunspell-ffi does not appear to support private or session dictionaries.)

For some projects it seems there are too many false positives for names and programming words. I've reduced this somewhat by automatically including many programming words in the session dictionary. One solution involves switching to hunspell which appears to have better-maintained word dictionaries. The other involves exploring an upper threshold for the edit distance between a given word and its suggestion.

Synopsis

$ rdoc -f spellcheck lib *.rdoc

Requirements

Install

sudo gem install rdoc-spellcheck

Developers

After checking out the source, run:

$ rake newb

This task will install any missing dependencies, run the tests/specs, and generate the RDoc.

License

(The MIT License)

Copyright © Eric Hodel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.