spellcheck: add examples

[torstehu]

No description provided.

[HumorBaby]

Since this is a spellcheck module, the typo is actually intentional 😄 If the command is run as is shown in the example (with "typo"), it will demonstrate how the bot responds to incorrectly spelled wrods words

[HumorBaby]

It may be helpful to add examples outputs to the @example decoration to 1) prevent such confusion regarding the examples, and 2) show what expected output is when (a) wrod is spelled incorrectly, and (b) word is spelled correctly.

The relevant arguments to the @example decorator:

sopel/sopel/module.py

Lines 428 to 440 in 95812b5

	class example(object):
	"""Decorate a function with an example.
	Args:
	msg:
	(required) The example command as sent by a user on IRC. If it is
	a prefixed command, the command prefix used in the example must
	match the default `config.core.help_prefix` for compatibility with
	the built-in help module.
	result:
	What the example command is expected to output. If given, a test is
	generated using `msg` as input. The test behavior can be modified
	by the remaining optional arguments.

In use:

sopel/sopel/modules/emoticons.py

Line 14 in ca02501

@example('.shrug', r'¯\_(ツ)_/¯')

So, @torstehu, building off your current suggested change, adding another @example with wrod and adding expected results for both @examples are needed for this PR, IMO.

[torstehu]

@HumorBaby Thanks for the clarification, I have tried to make some examples with one and two words, can you give me some comments on this commit?

[dgw]

I'm confused now, because I thought I included example tests in #1164. Wonder what happened to them… *digs around local repos*

[dgw]

The examples I wrote must be stashed on my office computer (which I probably won't see again until Monday)—or I accidentally reset the Git worktree and lost them.

Either way, these are very similar to what I had.

[Exirel]

All these look good! 🎉

[dgw]

The examples I wrote must be stashed on my office computer

Or not. I have no idea where they went, then.

@Exirel did you want to formally approve this, or let me take full responsibility? :P

[Exirel]

let me take full responsibility? :P

Yes. 😛

[Exirel]

@dgw I wonder if I should create a label "easy to merge" for you to check... ;-)

[dgw]

@Exirel It wouldn't speed up my merging pace, lol. I just don't like merging too much at once.