aboutsummaryrefslogtreecommitdiff
path: root/discord/utils.py
diff options
context:
space:
mode:
authorNCPlayz <[email protected]>2020-07-04 17:25:59 +0100
committerRapptz <[email protected]>2020-07-08 23:01:00 -0400
commit3408695a37f949f4ab0ebfea8d4dcf4a24d75972 (patch)
treec70c8e5678dc52f9e59affef00ac985eee191235 /discord/utils.py
parentDocument raises for Converter.convert (diff)
downloaddiscord.py-3408695a37f949f4ab0ebfea8d4dcf4a24d75972.tar.xz
discord.py-3408695a37f949f4ab0ebfea8d4dcf4a24d75972.zip
[docs] fix reference to `Guild` and document `utils.resolve_template`
Diffstat (limited to 'discord/utils.py')
-rw-r--r--discord/utils.py19
1 files changed, 17 insertions, 2 deletions
diff --git a/discord/utils.py b/discord/utils.py
index e42f5679..a6f3897e 100644
--- a/discord/utils.py
+++ b/discord/utils.py
@@ -429,11 +429,11 @@ def _string_width(string, *, _IS_ASCII=_IS_ASCII):
def resolve_invite(invite):
"""
- Resolves an invite from a :class:`~discord.Invite`, URL or ID
+ Resolves an invite from a :class:`~discord.Invite`, URL or code.
Parameters
-----------
- invite: Union[:class:`~discord.Invite`, :class:`~discord.Object`, :class:`str`]
+ invite: Union[:class:`~discord.Invite`, :class:`str`]
The invite.
Returns
@@ -452,6 +452,21 @@ def resolve_invite(invite):
return invite
def resolve_template(code):
+ """
+ Resolves a template code from a :class:`~discord.Template`, URL or code.
+
+ .. versionadded:: 1.4
+
+ Parameters
+ -----------
+ code: Union[:class:`~discord.Template`, :class:`str`]
+ The code.
+
+ Returns
+ --------
+ :class:`str`
+ The template code.
+ """
from .template import Template # circular import
if isinstance(code, Template):
return template.code