matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Fix docstrings for Webhook.send

Browse Source
This commit is contained in:
Rapptz
2017-09-08 04:23:11 -04:00
parent 4564b46f95
commit 8912625428
1 changed files with 22 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
discord/webhook.py
View File

@@ -495,7 +495,7 @@ class Webhook:
Deletes this Webhook. Deletes this Webhook.
If the webhook is constructed with a `RequestsWebhookAdapter` then this is If the webhook is constructed with a :class:`RequestsWebhookAdapter` then this is
not a coroutine. not a coroutine.
Raises Raises
@@ -514,7 +514,7 @@ class Webhook:
Edits this Webhook. Edits this Webhook.
If the webhook is constructed with a `RequestsWebhookAdapter` then this is If the webhook is constructed with a :class:`RequestsWebhookAdapter` then this is
not a coroutine. not a coroutine.
Parameters Parameters
@@ -559,10 +559,13 @@ class Webhook:
def send(self, content=None, *, wait=False, username=None, avatar_url=None, def send(self, content=None, *, wait=False, username=None, avatar_url=None,
tts=False, file=None, embed=None, embeds=None): tts=False, file=None, embed=None, embeds=None):
"""|coro| """|maybecoro|
Sends a message using the webhook. Sends a message using the webhook.
If the webhook is constructed with a :class:`RequestsWebhookAdapter` then this is
not a coroutine.
The content must be a type that can convert to a string through ``str(content)``. The content must be a type that can convert to a string through ``str(content)``.
To upload a single file, the ``file`` parameter should be used with a To upload a single file, the ``file`` parameter should be used with a
@@ -576,26 +579,26 @@ class Webhook:
------------ ------------
content content
The content of the message to send. The content of the message to send.
tts: bool wait: bool
Indicates if the message should be sent using text-to-speech. Whether the server should wait before sending a response. This essentially
embed: :class:`Embed` means that the return type of this function changes from ``None`` to
The rich embed for the content to send. This cannot be mixed with a :class:`Message` if set to ``True``.
``embeds`` parameter.
embeds: List[:class:`Embed`]
A list of embeds to send with the content. Maximum of 10. This cannot
be mixed with the ``embed`` parameter.
file: :class:`File`
The file to upload.
username: str username: str
The username to send with this message. If no username is provided The username to send with this message. If no username is provided
then the default username for the webhook is used. then the default username for the webhook is used.
avatar_url: str avatar_url: str
The avatar URL to send with this message. If no avatar URL is provided The avatar URL to send with this message. If no avatar URL is provided
then the default avatar for the webhook is used. then the default avatar for the webhook is used.
wait: bool tts: bool
Whether the server should wait before sending a response. This essentially Indicates if the message should be sent using text-to-speech.
means that the return type of this function changes from ``None`` to file: :class:`File`
a :class:`Message` if set to ``True``. The file to upload.
embed: :class:`Embed`
The rich embed for the content to send. This cannot be mixed with
``embeds`` parameter.
embeds: List[:class:`Embed`]
A list of embeds to send with the content. Maximum of 10. This cannot
be mixed with the ``embed`` parameter.
Raises Raises
-------- --------
@@ -606,8 +609,8 @@ class Webhook:
Forbidden Forbidden
The authorization token for the webhook is incorrect. The authorization token for the webhook is incorrect.
InvalidArgument InvalidArgument
You specified both ``file`` and ``files`` or the length of You specified both ``embed`` and ``embeds`` or the length of
``files`` was invalid. ``embeds`` was invalid.
Returns Returns
--------- ---------