mirror of
https://github.com/Rapptz/discord.py.git
synced 2025-06-03 10:32:42 +00:00
[docs] fix reference to Guild
and document utils.resolve_template
This commit is contained in:
parent
475762e8df
commit
3408695a37
@ -84,7 +84,7 @@ class Template:
|
||||
code: :class:`str`
|
||||
The template code.
|
||||
uses: :class:`int`
|
||||
How many time the template has been used.
|
||||
How many times the template has been used.
|
||||
name: :class:`str`
|
||||
The name of the template.
|
||||
description: :class:`str`
|
||||
@ -95,7 +95,7 @@ class Template:
|
||||
When the template was created.
|
||||
updated_at: :class:`datetime.datetime`
|
||||
When the template was last updated (referred to as "last synced" in the client).
|
||||
source_guild: :class:`TemplateGuild`
|
||||
source_guild: :class:`Guild`
|
||||
The source guild.
|
||||
"""
|
||||
|
||||
|
@ -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
|
||||
|
@ -729,6 +729,8 @@ Utility Functions
|
||||
|
||||
.. autofunction:: discord.utils.resolve_invite
|
||||
|
||||
.. autofunction:: discord.utils.resolve_template
|
||||
|
||||
.. autofunction:: discord.utils.sleep_until
|
||||
|
||||
Profile
|
||||
|
Loading…
x
Reference in New Issue
Block a user