Georg/dbot
1
0
Fork 0
forked from GitHub/dbot
Code Issues Pull Requests Projects Releases Wiki Activity

module documentation for spelling [#75]

Browse Source
This commit is contained in:
reality 2012-12-30 19:50:22 +00:00
parent 2e1de98df9
commit 2416a82f45
2 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -25,24 +25,3 @@ commands in the cloned repository:
git submodule init
git submodule update
## Modules:
### Spelling
Will attempt to correct a users' spelling by using the levenshtein distance
algorithm. One corrects the spelling of their previous message by simply posting
a message with their correction and an asterisk:
> user: I am a tutrle.
> user: *turtle
user meant: I am a turtle.
The regular expression for this module also accepts two asterisks at the
beginning of the correction, or at the end; it also accepts several words as the
correction and deals with these fairly intelligently. Users may also attempt
to correct another users like so:
> userone: I am a tutrle.
> usertwo: userone: *turtle
> usertwo thinks userone meant: I am a turtle.

22
modules/spelling/README.md Normal file
View File

@ -0,0 +1,22 @@
## Spelling
Fix your spelling.
### Description
Will attempt to correct a users' spelling by using the levenshtein distance
algorithm. One corrects the spelling of their previous message by simply posting
a message with their correction and an asterisk:
> user: I am a tutrle.
> user: *turtle
user meant: I am a turtle.
The regular expression for this module also accepts two asterisks at the
beginning of the correction, or at the end; it also accepts several words as the
correction and deals with these fairly intelligently. Users may also attempt
to correct another users like so:
> userone: I am a tutrle.
> usertwo: userone: *turtle
> usertwo thinks userone meant: I am a turtle.