From 2ff3f06467102171018b2e29c194812cab411b4c Mon Sep 17 00:00:00 2001 From: Andy Smith Date: Fri, 12 Jul 2019 10:17:20 -0700 Subject: [PATCH] Further docstring improvements --- sopel/bot.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/sopel/bot.py b/sopel/bot.py index b1bb9f2444..89576d8a9b 100644 --- a/sopel/bot.py +++ b/sopel/bot.py @@ -65,8 +65,7 @@ def __init__(self, config, daemon=False): """The :class:`sopel.config.Config` for the current Sopel instance.""" self.doc = {} - """ - A dictionary of command names to their documentation. + """A dictionary of command names to their documentation. Each command is mapped to its docstring and any available examples, if declared in the module's code. @@ -191,10 +190,9 @@ def write(self, args, text=None): # Shim this in here for autodocs and ``sopel.write(('PRIVMSG', ':Hello, world!'))`` will send ``PRIVMSG :Hello, world!`` to the server. - Newlines and carriage returns (``'\\n'`` and ``'\\r'``) are - removed before sending. Additionally, if the message (after joining) is - longer than than 510 characters, any remaining characters will not be - sent. + Newlines and carriage returns (``'\\n'`` and ``'\\r'``) are removed + before sending. Additionally, if the message (after joining) is longer + than than 510 characters, any remaining characters will not be sent. """ irc.Bot.write(self, args, text=text)