[docs] Work on embeds Guide #7498
Conversation
docs/guide/topics/embeds.rst
Outdated
|
|
||
| Embeds are a fundamental part of Discord's message format. | ||
|
|
||
| They allow you to embed rich content into your messages. |
There was a problem hiding this comment.
We should probably elaborate on what we mean by "rich content".
|
|
||
| The :class:`Embed` class allows usage of the `factory` pattern. | ||
|
|
||
| .. hint:: |
There was a problem hiding this comment.
It feels kind of silly to directive this as a hint when, without it, this section is only one sentence long.
| Next, we need to call :meth:`my_weather_embed.set_thumbnail() <Embed.set_thumbnail>` to set the thumbnail. | ||
| To refer to our attachment for the thumbnail, we will use a special URI scheme that Discord provides - ``attachment://``. | ||
|
|
||
| Since we called our file ``thumbnail.png``, we will set the ``url`` parameter to ``attachment://thumbnail.png``. |
There was a problem hiding this comment.
I'm a bit conflicted on whether we should explain some of the nuances of attachment:// or not.
Filenames get pivoted by Discord before they get attached to this protocol (e.g. my image.png becomes attachment://my_image.png) so maybe it's worth touching on it? Might be kind of out of the scope, but I also don't know where else we would bring this up.
| I have a page dedicated to [`C++ Tutorials`](https://rapptz.github.io/cpptuts)! | ||
| """ | ||
|
|
||
| .. image:: /images/guide/topics/embeds/hyperlink_tooltip_description_embed.png |
There was a problem hiding this comment.
Tiny tooltip! I know this is sort of inevitable since we're doing high quality screenshots, but it might even be worth photoshopping the tooltip to be larger so it looks a little less weird.
|
It appears these embed screenshots include a small client bug (that is fixed now). It makes the bottom margin too large:
It was caused by the client adding an empty
|
| .. todo | ||
| - cover footer | ||
| - cover timestamp |
| In the Discord client, each row of fields can contain a maximum of 3 fields. | ||
|
|
||
| If you wanted to, you could try using the ``inline`` keyword-only argument of :meth:`~Embed.add_field`. | ||
| This determines the positioning of the field within the embed. |
There was a problem hiding this comment.
I believe it's worth mentioning that inline actually controls the format of the next field.
If field 0 set's inline to False, then field 1 will appear on a new line, and so on.
NCPlayz
force-pushed
the
docs/guides/topics/embeds
branch
from
7413ed6 to
c2fbd98
Compare
Summary
work on embeds guide
Checklist