aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNCPlayz <[email protected]>2019-04-02 20:37:47 +0100
committerRapptz <[email protected]>2019-04-08 18:17:40 -0400
commit7acb7de195b9efb9871f1aff6aa04b18c6052156 (patch)
treec145326dced4d8b9a796ca95b6a8a6c67704fc09
parentFix documentation so Sphinx can build semi-cleanly. (diff)
downloaddiscord.py-7acb7de195b9efb9871f1aff6aa04b18c6052156.tar.xz
discord.py-7acb7de195b9efb9871f1aff6aa04b18c6052156.zip
Add notes stating what Guild.fetch_guild and Guild.fetch_guilds returns
Also fixed two typos.
-rw-r--r--discord/client.py14
1 files changed, 12 insertions, 2 deletions
diff --git a/discord/client.py b/discord/client.py
index 7ae87a4e..a72c1582 100644
--- a/discord/client.py
+++ b/discord/client.py
@@ -839,7 +839,12 @@ class Client:
def fetch_guilds(self, *, limit=100, before=None, after=None):
"""|coro|
- Retreives an :class:`AsyncIterator` that enables receiving your guilds.
+ Retrieves an :class:`AsyncIterator` that enables receiving your guilds.
+
+ .. note::
+
+ Using this, you will only receive :attr:`Guild.owner`, :attr:`Guild.icon`,
+ :attr:`Guild.id`, and :attr:`Guild.name` per :class:`Guild`.
All parameters are optional.
@@ -885,7 +890,12 @@ class Client:
async def fetch_guild(self, guild_id):
"""|coro|
- Retreives a :class:`Guild` from an ID.
+ Retrieves a :class:`Guild` from an ID.
+
+ .. note::
+
+ Using this, you will not receive :attr:`Guild.channels`, :class:`Guild.members`,
+ :attr:`Member.activity` and :attr:`Member.voice` per :class:`Member`.
Parameters
-----------