From bc00bc495e25ebb85e0bfbd14f669d109093e831 Mon Sep 17 00:00:00 2001 From: Rapptz Date: Thu, 18 Aug 2022 09:50:16 -0400 Subject: [PATCH] Document attachment:// URI more prominently in Embed docs --- discord/embeds.py | 4 ++++ docs/faq.rst | 2 ++ 2 files changed, 6 insertions(+) diff --git a/discord/embeds.py b/discord/embeds.py index 4fcb3b49e..6a79fef71 100644 --- a/discord/embeds.py +++ b/discord/embeds.py @@ -362,6 +362,7 @@ class Embed: The footer text. Can only be up to 2048 characters. icon_url: :class:`str` The URL of the footer icon. Only HTTP(S) is supported. + Inline attachment URLs are also supported, see :ref:`local_image`. """ self._footer = {} @@ -414,6 +415,7 @@ class Embed: ----------- url: :class:`str` 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: @@ -457,6 +459,7 @@ class Embed: ----------- url: :class:`str` 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: @@ -522,6 +525,7 @@ class Embed: The URL for the author. icon_url: :class:`str` The URL of the author icon. Only HTTP(S) is supported. + Inline attachment URLs are also supported, see :ref:`local_image`. """ self._author = { diff --git a/docs/faq.rst b/docs/faq.rst index 1369f4977..8a8ef39ff 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -318,6 +318,8 @@ Quick example: See `aiohttp's full documentation `_ for more information. +.. _local_image: + How do I use a local image file for an embed image? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~