Skip to content

Commit

Permalink
Included some problems in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
drbrain committed Apr 9, 2012
1 parent 9a2abec commit 31e88a0
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@ your own words to the default word list.
* 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
Expand Down

0 comments on commit 31e88a0

Please sign in to comment.