mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-05-13 17:29:50 +00:00
Code Issues Projects Releases Wiki Activity

Document attachment:// URI more prominently in Embed docs

Browse Source
This commit is contained in:
Rapptz 2022-08-18 09:50:16 -04:00
parent 38ec8cfb0e
commit bc00bc495e
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
discord/embeds.py
View File

@ -362,6 +362,7 @@ class Embed:
The footer text. Can only be up to 2048 characters. The footer text. Can only be up to 2048 characters.
icon_url: :class:`str` icon_url: :class:`str`
The URL of the footer icon. Only HTTP(S) is supported. The URL of the footer icon. Only HTTP(S) is supported.
Inline attachment URLs are also supported, see :ref:`local_image`.
""" """
self._footer = {} self._footer = {}
@ -414,6 +415,7 @@ class Embed:
----------- -----------
url: :class:`str` url: :class:`str`
The source URL for the image. Only HTTP(S) is supported. The source URL for the image. Only HTTP(S) is supported.
Inline attachment URLs are also supported, see :ref:`local_image`.
""" """
if url is None: if url is None:
@ -457,6 +459,7 @@ class Embed:
----------- -----------
url: :class:`str` url: :class:`str`
The source URL for the thumbnail. Only HTTP(S) is supported. The source URL for the thumbnail. Only HTTP(S) is supported.
Inline attachment URLs are also supported, see :ref:`local_image`.
""" """
if url is None: if url is None:
@ -522,6 +525,7 @@ class Embed:
The URL for the author. The URL for the author.
icon_url: :class:`str` icon_url: :class:`str`
The URL of the author icon. Only HTTP(S) is supported. The URL of the author icon. Only HTTP(S) is supported.
Inline attachment URLs are also supported, see :ref:`local_image`.
""" """
self._author = { self._author = {

2
docs/faq.rst
View File

@ -318,6 +318,8 @@ Quick example:
See `aiohttp's full documentation <http://aiohttp.readthedocs.io/en/stable/>`_ for more information. See `aiohttp's full documentation <http://aiohttp.readthedocs.io/en/stable/>`_ for more information.
.. _local_image:
How do I use a local image file for an embed image? How do I use a local image file for an embed image?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~