diff options
| author | Michael H <[email protected]> | 2021-02-17 07:33:17 -0500 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-02-17 07:33:17 -0500 |
| commit | 08d45cc2abba781245e3f5a2c356048e343f2335 (patch) | |
| tree | 5001e9f2d3cb7d25feab8c65bd108fb9222ec895 /docs | |
| parent | Fix documentation with reference in GroupChannel.permissions_for (diff) | |
| download | discord.py-08d45cc2abba781245e3f5a2c356048e343f2335.tar.xz discord.py-08d45cc2abba781245e3f5a2c356048e343f2335.zip | |
Update docs to be clearer about discord limitations
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 8 | ||||
| -rw-r--r-- | docs/intents.rst | 5 |
2 files changed, 11 insertions, 2 deletions
diff --git a/docs/api.rst b/docs/api.rst index 9990d036..0421d5a9 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -478,6 +478,14 @@ to handle it, which defaults to print a traceback and ignoring the exception. This requires :attr:`Intents.reactions` to be enabled. + .. note:: + + This doesn't require :attr:`Intents.members` within a guild context, + but due to Discord not providing updated user information in a direct message + it's required for direct messages to receive this event. + Consider using :func:`on_raw_reaction_add` if you need this and do not otherwise want + to enable the members intent. + :param reaction: The current state of the reaction. :type reaction: :class:`Reaction` :param user: The user who added the reaction. diff --git a/docs/intents.rst b/docs/intents.rst index 8ba036c9..38264b19 100644 --- a/docs/intents.rst +++ b/docs/intents.rst @@ -118,8 +118,9 @@ It should be noted that certain things do not need a member cache since Discord - :func:`on_message` will have :attr:`Message.author` be a member even if cache is disabled. - :func:`on_voice_state_update` will have the ``member`` parameter be a member even if cache is disabled. -- :func:`on_reaction_add` will have the ``user`` parameter be a member even if cache is disabled. -- :func:`on_raw_reaction_add` will have :attr:`RawReactionActionEvent.member` be a member even if cache is disabled. +- :func:`on_reaction_add` will have the ``user`` parameter be a member when in a guild even if cache is disabled. +- :func:`on_raw_reaction_add` will have :attr:`RawReactionActionEvent.member` be a member when in a guild even if cache is disabled. +- The reaction add events do not contain additional information when in direct messages. This is a Discord limitation. - The reaction removal events do not have the member information. This is a Discord limitation. Other events that take a :class:`Member` will require the use of the member cache. If absolute accuracy over the member cache is desirable, then it is advisable to have the :attr:`Intents.members` intent enabled. |