Fix and add documentation

This commit is contained in:
Michael
2020-09-23 00:19:35 -07:00
committed by GitHub
parent 37c5c583f2
commit 93fa46713a
15 changed files with 97 additions and 29 deletions

View File

@ -303,7 +303,7 @@ class Client:
return self._connection.voice_clients
def is_ready(self):
"""Specifies if the client's internal cache is ready for use."""
""":class:`bool`: Specifies if the client's internal cache is ready for use."""
return self._ready.is_set()
async def _run_event(self, coro, event_name, *args, **kwargs):
@ -683,7 +683,7 @@ class Client:
# properties
def is_closed(self):
"""Indicates if the websocket connection is closed."""
""":class:`bool`: Indicates if the websocket connection is closed."""
return self._closed
@property
@ -800,6 +800,11 @@ class Client:
Just because you receive a :class:`.abc.GuildChannel` does not mean that
you can communicate in said channel. :meth:`.abc.GuildChannel.permissions_for` should
be used for that.
Yields
------
:class:`.abc.GuildChannel`
A channel the client can 'access'.
"""
for guild in self.guilds:
@ -814,6 +819,11 @@ class Client:
for guild in client.guilds:
for member in guild.members:
yield member
Yields
------
:class:`.Member`
A member the client can see.
"""
for guild in self.guilds:
for member in guild.members: