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

Remove notes about Client.messages

Browse Source 
Since `Client.messages` no longer exists, I think we should remove the note about the cache being named that.
This commit is contained in:
Xua 2019-02-03 20:15:14 +13:00 committed by Rapptz
parent bb9f153d29
commit a9860bd156
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api.rst
View File

@ -216,7 +216,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
.. function:: on_message_delete(message) .. function:: on_message_delete(message)
Called when a message is deleted. If the message is not found in the Called when a message is deleted. If the message is not found in the
:attr:`Client.messages` cache, then these events will not be called. This internal message cache, then these events will not be called. This
happens if the message is too old or the client is participating in high happens if the message is too old or the client is participating in high
traffic guilds. To fix this, increase the ``max_messages`` option of traffic guilds. To fix this, increase the ``max_messages`` option of
:class:`Client`. :class:`Client`.
@ -242,7 +242,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
.. function:: on_message_edit(before, after) .. function:: on_message_edit(before, after)
Called when a :class:`Message` receives an update event. If the message is not found Called when a :class:`Message` receives an update event. If the message is not found
in the :attr:`Client.messages` cache, then these events will not be called. in the internal message cache, then these events will not be called.
This happens if the message is too old or the client is participating in high This happens if the message is too old or the client is participating in high
traffic guilds. To fix this, increase the ``max_messages`` option of :class:`Client`. traffic guilds. To fix this, increase the ``max_messages`` option of :class:`Client`.
@ -278,7 +278,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
.. function:: on_reaction_add(reaction, user) .. function:: on_reaction_add(reaction, user)
Called when a message has a reaction added to it. Similar to on_message_edit, Called when a message has a reaction added to it. Similar to on_message_edit,
if the message is not found in the :attr:`Client.messages` cache, then this if the message is not found in the internal message cache, then this
event will not be called. event will not be called.
.. note:: .. note::
@ -299,7 +299,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
.. function:: on_reaction_remove(reaction, user) .. function:: on_reaction_remove(reaction, user)
Called when a message has a reaction removed from it. Similar to on_message_edit, Called when a message has a reaction removed from it. Similar to on_message_edit,
if the message is not found in the :attr:`Client.messages` cache, then this event if the message is not found in the internal message cache, then this event
will not be called. will not be called.
.. note:: .. note::
@ -320,7 +320,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
.. function:: on_reaction_clear(message, reactions) .. function:: on_reaction_clear(message, reactions)
Called when a message has all its reactions removed from it. Similar to :func:`on_message_edit`, Called when a message has all its reactions removed from it. Similar to :func:`on_message_edit`,
if the message is not found in the :attr:`Client.messages` cache, then this event if the message is not found in the internal message cache, then this event
will not be called. will not be called.
:param message: The :class:`Message` that had its reactions cleared. :param message: The :class:`Message` that had its reactions cleared.