Skip to content

Commit

Permalink
Further docstring improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
nsnw committed Jul 12, 2019
1 parent e19bd7f commit 2ff3f06
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions sopel/bot.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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)

Expand Down

0 comments on commit 2ff3f06

Please sign in to comment.