spellcheck: add examples

sopel-irc · Apr 5, 2019 · d071412 · d071412
1 parent 95812b5
commit d071412
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/sopel/modules/spellcheck.py b/sopel/modules/spellcheck.py
@@ -130,7 +130,11 @@ def check_one(bot, word):
 
 
 @commands('spellcheck', 'spell', 'sc')
-@example('.spellcheck wrod')
+@example('.spellcheck word', 'word is spelled correctly')
+@example('.spellcheck wrod', r'wrod is not spelled correctly. Maybe you want one of these spellings: .*')
+@example('.spellcheck word trigger', 'Nothing seems to be misspelled.')
+@example('.spellcheck word triger', r'The following word(s) seem to be misspelled: .*')
+@example('.spellcheck wrod triger', r'The following word(s) seem to be misspelled: .*')
 def spellchecker(bot, trigger):
     """
     Checks if the given word is spelled correctly, and suggests corrections.