aboutsummaryrefslogtreecommitdiff
path: root/discord/ext/commands/converter.py
diff options
context:
space:
mode:
authorNCPlayz <[email protected]>2019-03-16 21:43:55 +0000
committerRapptz <[email protected]>2019-03-19 08:24:42 -0400
commitfb02191b80972a9cf7c3baa765cb3aa84c6f1cfa (patch)
tree7a0a5c9aaa5cc5bac26fc51caf4fdffbaee64c26 /discord/ext/commands/converter.py
parentTake back ownership of files from aiohttp for retrying requests. (diff)
downloaddiscord.py-fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa.tar.xz
discord.py-fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa.zip
Organise documentation
Diffstat (limited to 'discord/ext/commands/converter.py')
-rw-r--r--discord/ext/commands/converter.py11
1 files changed, 4 insertions, 7 deletions
diff --git a/discord/ext/commands/converter.py b/discord/ext/commands/converter.py
index 32476380..9fc6cf6d 100644
--- a/discord/ext/commands/converter.py
+++ b/discord/ext/commands/converter.py
@@ -69,7 +69,7 @@ class Converter:
-----------
ctx: :class:`.Context`
The invocation context that the argument is being used in.
- argument: str
+ argument: :class:`str`
The argument that is being converted.
"""
raise NotImplementedError('Derived classes need to implement this.')
@@ -304,7 +304,6 @@ class ColourConverter(Converter):
class RoleConverter(IDConverter):
"""Converts to a :class:`Role`.
-
All lookups are via the local guild. If in a DM context, then the lookup
is done by the global cache.
@@ -349,7 +348,6 @@ class InviteConverter(Converter):
class EmojiConverter(IDConverter):
"""Converts to a :class:`Emoji`.
-
All lookups are done for the local guild first, if available. If that lookup
fails, then it checks the client's global cache.
@@ -390,7 +388,6 @@ class EmojiConverter(IDConverter):
class PartialEmojiConverter(Converter):
"""Converts to a :class:`PartialEmoji`.
-
This is done by extracting the animated flag, name and ID from the emoji.
"""
async def convert(self, ctx, argument):
@@ -413,11 +410,11 @@ class clean_content(Converter):
Attributes
------------
- fix_channel_mentions: :obj:`bool`
+ fix_channel_mentions: :class:`bool`
Whether to clean channel mentions.
- use_nicknames: :obj:`bool`
+ use_nicknames: :class:`bool`
Whether to use nicknames when transforming mentions.
- escape_markdown: :obj:`bool`
+ escape_markdown: :class:`bool`
Whether to also escape special markdown characters.
"""
def __init__(self, *, fix_channel_mentions=False, use_nicknames=True, escape_markdown=False):