Clarify the docstring for privmsgs.getArgs

This commit is contained in:
James Vega 2003-12-09 15:58:05 +00:00
parent 66ec4ab4d7
commit 3ef5f546a1

View File

@ -66,7 +66,8 @@ def getArgs(args, required=1, optional=0):
"""Take the required/optional arguments from args. """Take the required/optional arguments from args.
Always returns a list of size required + optional, filling it with however Always returns a list of size required + optional, filling it with however
many empty strings is necessary to fill the tuple to the right size. many empty strings is necessary to fill the tuple to the right size. If
there is only one argument, a string containing that argument is returned.
If there aren't enough args even to satisfy required, raise an error and If there aren't enough args even to satisfy required, raise an error and
let the caller handle sending the help message. let the caller handle sending the help message.