Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-05 06:49:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

plugin_tutorial: consistently use the decorator @wrap syntax

Browse Source
This commit is contained in:
James Lu
2023-05-07 12:48:51 -07:00
committed by James Lu
parent 007b64edb7
commit b0c881f41b
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
develop/plugin_tutorial.rst
View File

@ -279,6 +279,7 @@ sample of arbitrary size from a list provided by the user:
.. code-block:: .. code-block::
:dedent: 0 :dedent: 0
@wrap(['int', many('anything')])
def sample(self, irc, msg, args, n, items): def sample(self, irc, msg, args, n, items):
"""<number of items> <item1> [<item2> ...] """<number of items> <item1> [<item2> ...]
@ -289,11 +290,10 @@ sample of arbitrary size from a list provided by the user:
if n > len(items): if n > len(items):
# Calling irc.error with Raise=True is an alternative early return # Calling irc.error with Raise=True is an alternative early return
irc.error('<number of items> must be less than the number ' irc.error('<number of items> must be less than the number '
'of arguments.', Raise=True) 'of arguments.', Raise=True)
sample = self.rng.sample(items, n) sample = self.rng.sample(items, n)
sample.sort() sample.sort()
irc.reply(utils.str.commaAndify(sample)) irc.reply(utils.str.commaAndify(sample))
sample = wrap(sample, ['int', many('anything')])
The important thing to note is that list type arguments are rolled into one The important thing to note is that list type arguments are rolled into one
parameter in the command function by the ``many`` filter. Similar "multiplicity" parameter in the command function by the ``many`` filter. Similar "multiplicity"
@ -328,6 +328,7 @@ defaulting to 6:
.. code-block:: .. code-block::
:dedent: 0 :dedent: 0
@wrap([additional(('int', 'number of sides'), 6)])
def diceroll(self, irc, msg, args, n): def diceroll(self, irc, msg, args, n):
"""[<number of sides>] """[<number of sides>]
@ -336,7 +337,6 @@ defaulting to 6:
""" """
s = 'rolls a %s' % self.rng.randrange(1, n) s = 'rolls a %s' % self.rng.randrange(1, n)
irc.reply(s, action=True) irc.reply(s, action=True)
diceroll = wrap(diceroll, [additional(('int', 'number of sides'), 6)])
The only new thing described here is that ``irc.reply(..., action=True)`` makes The only new thing described here is that ``irc.reply(..., action=True)`` makes
the bot perform a `/me`. There are some other flags described in the the bot perform a `/me`. There are some other flags described in the