Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2025-01-26 20:24:37 +01:00
Code Issues Projects Releases Wiki Activity

plugin_tutorial: Add links to irc.replySuccess() and irc.error()

Browse Source
This commit is contained in:
Valentin Lorentz 2021-04-05 21:32:07 +02:00
parent 038490307f
commit e00596feb0
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
develop/plugin_tutorial.rst
View File

@ -364,7 +364,9 @@ on the first line. Arguments go in <> and optional arguments should be
surrounded by ``[]`` (we'll demonstrate this later as well). surrounded by ``[]`` (we'll demonstrate this later as well).
The body of the function should be fairly straightforward to figure out, but it The body of the function should be fairly straightforward to figure out, but it
introduces a new function - irc.replySuccess. This is just a generic "I introduces a new function -
:py:meth:`irc.replySuccess <supybot.callbacks.RichReplyMethods.replySuccess>`.
This is just a generic "I
succeeded" command which responds with whatever the bot owner has configured to succeeded" command which responds with whatever the bot owner has configured to
be the success response (configured in supybot.replies.success). Note that we be the success response (configured in supybot.replies.success). Note that we
don't do any error-checking in the plugin, and that's because we simply don't don't do any error-checking in the plugin, and that's because we simply don't
@ -411,7 +413,9 @@ optional items after the first item.
The body of the plugin should be relatively easy to read. First we check and The body of the plugin should be relatively easy to read. First we check and
make sure that n (the number of items the user wants to sample) is not larger make sure that n (the number of items the user wants to sample) is not larger
than the actual number of items they gave. If it does, we call irc.error with than the actual number of items they gave. If it does, we call irc.error with
the error message you see. irc.error is kind of like irc.replySuccess only it the error message you see.
:py:meth:`irc.error <supybot.callbacks.NestedCommandsIrcProxy.error>`
is kind of like irc.replySuccess only it
gives an error message using the configured error format (in gives an error message using the configured error format (in
``supybot.replies.error``). Otherwise, we use the sample function from our RNG to ``supybot.replies.error``). Otherwise, we use the sample function from our RNG to
get a sample, then we sort it, and we reply with the 'utils.str.commaAndify'ed get a sample, then we sort it, and we reply with the 'utils.str.commaAndify'ed