Fix various inconsistencies within the documentation (#5067)
This commit is contained in:
@ -453,15 +453,13 @@ class Webhook:
|
||||
|
||||
@property
|
||||
def url(self):
|
||||
"""Returns the webhook's url."""
|
||||
""":class:`str` : Returns the webhook's url."""
|
||||
return 'https://discord.com/api/webhooks/{}/{}'.format(self.id, self.token)
|
||||
|
||||
@classmethod
|
||||
def partial(cls, id, token, *, adapter):
|
||||
"""Creates a partial :class:`Webhook`.
|
||||
|
||||
A partial webhook is just a webhook object with an ID and a token.
|
||||
|
||||
Parameters
|
||||
-----------
|
||||
id: :class:`int`
|
||||
@ -472,6 +470,12 @@ class Webhook:
|
||||
The webhook adapter to use when sending requests. This is
|
||||
typically :class:`AsyncWebhookAdapter` for :doc:`aiohttp <aio:index>` or
|
||||
:class:`RequestsWebhookAdapter` for :doc:`req:index`.
|
||||
|
||||
Returns
|
||||
--------
|
||||
:class:`Webhook`
|
||||
A partial :class:`Webhook`.
|
||||
A partial webhook is just a webhook object with an ID and a token.
|
||||
"""
|
||||
|
||||
if not isinstance(adapter, WebhookAdapter):
|
||||
@ -502,6 +506,12 @@ class Webhook:
|
||||
-------
|
||||
InvalidArgument
|
||||
The URL is invalid.
|
||||
|
||||
Returns
|
||||
--------
|
||||
:class:`Webhook`
|
||||
A partial :class:`Webhook`.
|
||||
A partial webhook is just a webhook object with an ID and a token.
|
||||
"""
|
||||
|
||||
m = re.search(r'discord(?:app)?.com/api/webhooks/(?P<id>[0-9]{17,21})/(?P<token>[A-Za-z0-9\.\-\_]{60,68})', url)
|
||||
@ -560,7 +570,7 @@ class Webhook:
|
||||
|
||||
@property
|
||||
def avatar_url(self):
|
||||
"""Returns an :class:`Asset` for the avatar the webhook has.
|
||||
""":class:`Asset`: Returns an :class:`Asset` for the avatar the webhook has.
|
||||
|
||||
If the webhook does not have a traditional avatar, an asset for
|
||||
the default avatar is returned instead.
|
||||
|
Reference in New Issue
Block a user