Browse Source

Fix backslashes showing up in the docs

pull/6457/head
Sebastian Law 4 years ago
committed by GitHub
parent
commit
a0c1d6f6c5
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 4
      discord/utils.py
  2. 2
      docs/api.rst

4
discord/utils.py

@ -492,8 +492,8 @@ def escape_markdown(text, *, as_needed=False, ignore_links=True):
as_needed: :class:`bool` as_needed: :class:`bool`
Whether to escape the markdown characters as needed. This Whether to escape the markdown characters as needed. This
means that it does not escape extraneous characters if it's means that it does not escape extraneous characters if it's
not necessary, e.g. ``**hello**`` is escaped into ``\*\*hello**`` not necessary, e.g. ``**hello**`` is escaped into ``**hello**``
instead of ``\*\*hello\*\*``. Note however that this can open instead of ``**hello**``. Note however that this can open
you up to some clever syntax abuse. Defaults to ``False``. you up to some clever syntax abuse. Defaults to ``False``.
ignore_links: :class:`bool` ignore_links: :class:`bool`
Whether to leave links alone when escaping markdown. For example, Whether to leave links alone when escaping markdown. For example,

2
docs/api.rst

@ -250,7 +250,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
:param shard_id: The shard ID that has resumed. :param shard_id: The shard ID that has resumed.
:type shard_id: :class:`int` :type shard_id: :class:`int`
.. function:: on_error(event, \*args, \*\*kwargs) .. function:: on_error(event, *args, **kwargs)
Usually when an event raises an uncaught exception, a traceback is Usually when an event raises an uncaught exception, a traceback is
printed to stderr and the exception is ignored. If you want to printed to stderr and the exception is ignored. If you want to

Loading…
Cancel
Save