Fix style to Keyword Args

This commit is contained in:
Griatch 2020-10-12 21:13:06 +02:00
parent fcb6f19287
commit b449ebe3d4
55 changed files with 157 additions and 157 deletions

View file

@ -303,7 +303,7 @@ class GrapevineClient(WebSocketClientProtocol, Session):
"""
Send data grapevine -> Evennia
Keyword args:
Keyword Args:
data (dict): Converted json data.
"""

View file

@ -275,7 +275,7 @@ class IRCBot(irc.IRCClient, Session):
"""
Data IRC -> Server.
Keyword args:
Keyword Args:
text (str): Ingoing text.
kwargs (any): Other data from protocol.
@ -306,7 +306,7 @@ class IRCBot(irc.IRCClient, Session):
Args:
text (str): Outgoing text.
Keyword args:
Keyword Args:
user (str): the nick to send
privately to.
@ -375,7 +375,7 @@ class IRCBotFactory(protocol.ReconnectingClientFactory):
Args:
sessionhandler (SessionHandler): Reference to the main Sessionhandler.
Keyword args:
Keyword Args:
uid (int): Bot user id.
botname (str): Bot name (seen in IRC channel).
channel (str): IRC channel to connect to.

View file

@ -389,7 +389,7 @@ class PortalSessionHandler(SessionHandler):
Args:
session (PortalSession): Session receiving data.
Keyword args:
Keyword Args:
kwargs (any): Other data from protocol.
Notes:
@ -447,7 +447,7 @@ class PortalSessionHandler(SessionHandler):
Args:
session (Session): Session sending data.
Keyword args:
Keyword Args:
kwargs (any): Each key is a command instruction to the
protocol on the form key = [[args],{kwargs}]. This will
call a method send_<key> on the protocol. If no such

View file

@ -88,7 +88,7 @@ class RSSReader(Session):
"""
Data RSS -> Evennia.
Keyword args:
Keyword Args:
text (str): Incoming text
kwargs (any): Options from protocol.

View file

@ -264,7 +264,7 @@ class SshProtocol(Manhole, _BASE_SESSION_CLASS):
"""
Data Evennia -> User
Keyword args:
Keyword Args:
kwargs (any): Options to the protocol.
"""
@ -277,7 +277,7 @@ class SshProtocol(Manhole, _BASE_SESSION_CLASS):
Args:
text (str): The first argument is always the text string to send. No other arguments
are considered.
Keyword args:
Keyword Args:
options (dict): Send-option flags (booleans)
- mxp: enforce mxp link support.

View file

@ -362,7 +362,7 @@ class TelnetProtocol(Telnet, StatefulTelnetProtocol, _BASE_SESSION_CLASS):
"""
Data User -> Evennia
Keyword args:
Keyword Args:
kwargs (any): Options from the protocol.
"""
@ -375,7 +375,7 @@ class TelnetProtocol(Telnet, StatefulTelnetProtocol, _BASE_SESSION_CLASS):
"""
Data Evennia -> User
Keyword args:
Keyword Args:
kwargs (any): Options to the protocol
"""
self.sessionhandler.data_out(self, **kwargs)
@ -389,7 +389,7 @@ class TelnetProtocol(Telnet, StatefulTelnetProtocol, _BASE_SESSION_CLASS):
Args:
text (str): The first argument is always the text string to send. No other arguments
are considered.
Keyword args:
Keyword Args:
options (dict): Send-option flags
- mxp: Enforce MXP link support.

View file

@ -240,7 +240,7 @@ class WebSocketClient(WebSocketServerProtocol, _BASE_SESSION_CLASS):
Args:
text (str): Text to send.
Keyword args:
Keyword Args:
options (dict): Options-dict with the following keys understood:
- raw (bool): No parsing at all (leave ansi-to-html markers unparsed).
- nocolor (bool): Clean out all color.
@ -293,7 +293,7 @@ class WebSocketClient(WebSocketServerProtocol, _BASE_SESSION_CLASS):
cmdname (str): The first argument will always be the oob cmd name.
*args (any): Remaining args will be arguments for `cmd`.
Keyword args:
Keyword Args:
options (dict): These are ignored for oob commands. Use command
arguments (which can hold dicts) to send instructions to the
client instead.

View file

@ -382,7 +382,7 @@ class AjaxWebClientSession(session.Session):
"""
Data User -> Evennia
Keyword args:
Keyword Args:
kwargs (any): Incoming data.
"""
@ -392,7 +392,7 @@ class AjaxWebClientSession(session.Session):
"""
Data Evennia -> User
Keyword args:
Keyword Args:
kwargs (any): Options to the protocol
"""
self.sessionhandler.data_out(self, **kwargs)
@ -405,7 +405,7 @@ class AjaxWebClientSession(session.Session):
Args:
text (str): Text to send.
Keyword args:
Keyword Args:
options (dict): Options-dict with the following keys understood:
- raw (bool): No parsing at all (leave ansi-to-html markers unparsed).
- nocolor (bool): Remove all color.
@ -457,7 +457,7 @@ class AjaxWebClientSession(session.Session):
cmdname (str): The first argument will always be the oob cmd name.
*args (any): Remaining args will be arguments for `cmd`.
Keyword args:
Keyword Args:
options (dict): These are ignored for oob commands. Use command
arguments (which can hold dicts) to send instructions to the
client instead.