Browse Source

Add notes warning that fetch_ methods are api calls

Also recommends using cache attributes/methods instead
pull/2065/head
Vexs 6 years ago
committed by Rapptz
parent
commit
4df0f79a6b
  1. 12
      discord/client.py
  2. 13
      discord/guild.py

12
discord/client.py

@ -861,6 +861,10 @@ class Client:
Using this, you will only receive :attr:`Guild.owner`, :attr:`Guild.icon`, Using this, you will only receive :attr:`Guild.owner`, :attr:`Guild.icon`,
:attr:`Guild.id`, and :attr:`Guild.name` per :class:`Guild`. :attr:`Guild.id`, and :attr:`Guild.name` per :class:`Guild`.
.. note::
This method is an API call. For general usage, consider :attr:`guilds` instead.
All parameters are optional. All parameters are optional.
Parameters Parameters
@ -912,6 +916,10 @@ class Client:
Using this, you will not receive :attr:`Guild.channels`, :class:`Guild.members`, Using this, you will not receive :attr:`Guild.channels`, :class:`Guild.members`,
:attr:`Member.activity` and :attr:`Member.voice` per :class:`Member`. :attr:`Member.activity` and :attr:`Member.voice` per :class:`Member`.
.. note::
This method is an API call. For general usage, consider :meth:`get_guild` instead.
Parameters Parameters
----------- -----------
guild_id: :class:`int` guild_id: :class:`int`
@ -1099,6 +1107,10 @@ class Client:
with the user to get this information, however many operations with the user to get this information, however many operations
do require that you do. do require that you do.
.. note::
This method is an API call. For general usage, consider :meth:`get_user` instead.
Parameters Parameters
----------- -----------
user_id: :class:`int` user_id: :class:`int`

13
discord/guild.py

@ -931,6 +931,10 @@ class Guild(Hashable):
Retreives a :class:`Member` from a guild ID, and a member ID. Retreives a :class:`Member` from a guild ID, and a member ID.
.. note::
This method is an API call. For general usage, consider :meth:`get_member` instead.
Parameters Parameters
----------- -----------
member_id: :class:`int` member_id: :class:`int`
@ -1149,6 +1153,10 @@ class Guild(Hashable):
Retrieves all custom :class:`Emoji`\s from the guild. Retrieves all custom :class:`Emoji`\s from the guild.
.. note::
This method is an API call. For general usage, consider :attr:`emojis` instead.
Raises Raises
--------- ---------
HTTPException HTTPException
@ -1167,6 +1175,11 @@ class Guild(Hashable):
Retrieves a custom :class:`Emoji` from the guild. Retrieves a custom :class:`Emoji` from the guild.
.. note::
This method is an API call.
For general usage, consider iterating over :attr:`emojis` instead.
Parameters Parameters
------------- -------------
emoji_id: :class:`int` emoji_id: :class:`int`

Loading…
Cancel
Save