GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 09:19:23 +01:00
Code Issues Projects Releases Wiki Activity

example.py: update to reflect 1.1.x docstring changes (#307)

Browse Source
This commit is contained in:
James Lu 2017-01-21 11:26:39 -08:00
parent 7bbe77fe4a
commit 1fe64cca04
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
plugins/example.py
View File

@ -36,16 +36,22 @@ utils.add_hook(hook_privmsg, 'PRIVMSG')
# source: The UID/numeric of the calling user. # source: The UID/numeric of the calling user.
# args: A list of command args (excluding the command name) that the command was called with. # args: A list of command args (excluding the command name) that the command was called with.
def randint(irc, source, args): def randint(irc, source, args):
# The docstring here is used as command help by the 'help' command, and formatted using the # The 'help' command uses command functions' docstrings as help text, and formats them
# same line breaks as the raw string. You shouldn't make this text or any one line too long, # in the following manner:
# to prevent flooding users or getting long lines cut off. # - Any newlines immediately adjacent to text on both sides are replaced with a space. This
# means that the first descriptive paragraph ("Returns a random...given.") shows up as one
# line, even though it is physically written on two.
# - Double line breaks are treated as breaks between two paragraphs, and will be shown
# as distinct lines in IRC.
# The same applies to message replies in general: plugins sending long strings of text should # Note: you shouldn't make any one paragraph too long, since they may get cut off. Automatic
# be wary that long messages can get cut off. Automatic word-wrap may be added in the future: # word-wrap may be added in the future; see https://github.com/GLolol/PyLink/issues/153
# https://github.com/GLolol/PyLink/issues/153
"""[<min> <max>] """[<min> <max>]
Returns a random number between <min> and <max>. <min> and <max> default
to 1 and 10 respectively, if both aren't given.""" Returns a random number between <min> and <max>. <min> and <max> default to 1 and 10
respectively, if both aren't given.
Example second paragraph here."""
try: try:
rmin = args[0] rmin = args[0]
rmax = args[1] rmax = args[1]