Fix style to Keyword Args
This commit is contained in:
parent
fcb6f19287
commit
b449ebe3d4
55 changed files with 157 additions and 157 deletions
|
|
@ -410,7 +410,7 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
|
|||
"""
|
||||
Checks if a given username or IP is banned.
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
ip (str, optional): IP address.
|
||||
username (str, optional): Username.
|
||||
|
||||
|
|
@ -481,7 +481,7 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
|
|||
password (str): Password of account
|
||||
ip (str, optional): IP address of client
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
session (Session, optional): Session requesting authentication
|
||||
|
||||
Returns:
|
||||
|
|
@ -611,7 +611,7 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
|
|||
Args:
|
||||
password (str): Password to validate
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
account (DefaultAccount, optional): Account object to validate the
|
||||
password for. Optional, but Django includes some validators to
|
||||
do things like making sure users aren't setting passwords to the
|
||||
|
|
@ -705,7 +705,7 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
|
|||
with default (or overridden) permissions and having joined them to the
|
||||
appropriate default channels.
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
username (str): Username of Account owner
|
||||
password (str): Password of Account owner
|
||||
email (str, optional): Email address of Account owner
|
||||
|
|
@ -872,7 +872,7 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
|
|||
default send behavior for the current
|
||||
MULTISESSION_MODE.
|
||||
options (list): Protocol-specific options. Passed on to the protocol.
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
any (dict): All other keywords are passed on to the protocol.
|
||||
|
||||
"""
|
||||
|
|
@ -920,7 +920,7 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
|
|||
session (Session, optional): The session to be responsible
|
||||
for the command-send
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
kwargs (any): Other keyword arguments will be added to the
|
||||
found command object instance as variables before it
|
||||
executes. This is unused by default Evennia but may be
|
||||
|
|
@ -1036,7 +1036,7 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
|
|||
no_superuser_bypass (bool, optional): Turn off superuser
|
||||
lock bypassing. Be careful with this one.
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
kwargs (any): Passed to the at_access hook along with the result.
|
||||
|
||||
Returns:
|
||||
|
|
@ -1180,7 +1180,7 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
|
|||
check.
|
||||
access_type (str): The type of access checked.
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
kwargs (any): These are passed on from the access check
|
||||
and can be used to relay custom instructions from the
|
||||
check mechanism.
|
||||
|
|
@ -1385,7 +1385,7 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
|
|||
text (str, optional): The message received.
|
||||
from_obj (any, optional): The object sending the message.
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
This includes any keywords sent to the `msg` method.
|
||||
|
||||
Returns:
|
||||
|
|
@ -1407,7 +1407,7 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
|
|||
text (str, optional): Text to send.
|
||||
to_obj (any, optional): The object to send to.
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
Keywords passed from msg()
|
||||
|
||||
Notes:
|
||||
|
|
@ -1566,7 +1566,7 @@ class DefaultGuest(DefaultAccount):
|
|||
"""
|
||||
Gets or creates a Guest account object.
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
ip (str, optional): IP address of requestor; used for ban checking,
|
||||
throttling and logging
|
||||
|
||||
|
|
|
|||
|
|
@ -278,7 +278,7 @@ class IRCBot(Bot):
|
|||
Args:
|
||||
text (str, optional): Incoming text from channel.
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
options (dict): Options dict with the following allowed keys:
|
||||
- from_channel (str): dbid of a channel this text originated from.
|
||||
- from_obj (list): list of objects sending this text.
|
||||
|
|
@ -308,7 +308,7 @@ class IRCBot(Bot):
|
|||
session (Session, optional): Session responsible for this
|
||||
command. Note that this is the bot.
|
||||
txt (str, optional): Command string.
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
user (str): The name of the user who sent the message.
|
||||
channel (str): The name of channel the message was sent to.
|
||||
type (str): Nature of message. Either 'msg', 'action', 'nicklist'
|
||||
|
|
@ -518,7 +518,7 @@ class GrapevineBot(Bot):
|
|||
Args:
|
||||
text (str, optional): Incoming text from channel.
|
||||
|
||||
Keyword args:
|
||||
Keyword Args:
|
||||
options (dict): Options dict with the following allowed keys:
|
||||
- from_channel (str): dbid of a channel this text originated from.
|
||||
- from_obj (list): list of objects sending this text.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue