Skip to content

Commit

Permalink
bot: eliminate problematic xrefs from SopelWrapper docs
Browse files Browse the repository at this point in the history
The formatting, in particular, is what was problematic here. Sphinx
doesn't provide a way to negate the monospace formatting of a :meth:
reference when using a custom title, so the only way to avoid having
random monospace words in the middle of this paragraph is... rewriting
to eliminate the xrefs.

Which is to say, if there's a better answer to this question
(https://stackoverflow.com/q/45741326/5991) in the future, we can put
this back the way it was.
  • Loading branch information
dgw committed Apr 8, 2023
1 parent b5eba03 commit c53d2d5
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions sopel/bot.py
Original file line number Diff line number Diff line change
Expand Up @@ -1230,9 +1230,9 @@ class SopelWrapper:
(e.g. plugin tag)
This wrapper will be used to call Sopel's triggered commands and rules as
their ``bot`` argument. It acts as a proxy to :meth:`send messages<say>`
to the sender (either a channel or in a private message) and even to
:meth:`reply to someone<reply>` in a channel.
their ``bot`` argument. It acts as a proxy, providing the ``trigger``'s
``sender`` (source channel or private message) as the default
``destination`` argument for overridden methods.
"""
def __init__(self, sopel, trigger, output_prefix=''):
if not output_prefix:
Expand Down

0 comments on commit c53d2d5

Please sign in to comment.