aboutsummaryrefslogtreecommitdiff
path: root/discord/client.py
diff options
context:
space:
mode:
authorSebastian Law <[email protected]>2020-06-28 00:45:58 -0700
committerGitHub <[email protected]>2020-06-28 03:45:58 -0400
commitb4b953bfc66adc235e06774b0481ceb847753793 (patch)
tree2d0cbd871944e3a5184b2dbec75dc59ddabad6d5 /discord/client.py
parentFix a KeyError for channels with no category in Guild.by_category (diff)
downloaddiscord.py-b4b953bfc66adc235e06774b0481ceb847753793.tar.xz
discord.py-b4b953bfc66adc235e06774b0481ceb847753793.zip
Fix various inconsistencies within the documentation (#5067)
Diffstat (limited to 'discord/client.py')
-rw-r--r--discord/client.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/discord/client.py b/discord/client.py
index e6c12f68..88cd09a1 100644
--- a/discord/client.py
+++ b/discord/client.py
@@ -123,10 +123,10 @@ class Client:
-----------
max_messages: Optional[:class:`int`]
The maximum number of messages to store in the internal message cache.
- This defaults to 1000. Passing in ``None`` disables the message cache.
+ This defaults to ``1000``. Passing in ``None`` disables the message cache.
.. versionchanged:: 1.3
- Allow disabling the message cache and change the default size to 1000.
+ Allow disabling the message cache and change the default size to ``1000``.
loop: Optional[:class:`asyncio.AbstractEventLoop`]
The :class:`asyncio.AbstractEventLoop` to use for asynchronous operations.
Defaults to ``None``, in which case the default event loop is used via
@@ -138,7 +138,7 @@ class Client:
proxy_auth: Optional[:class:`aiohttp.BasicAuth`]
An object that represents proxy HTTP Basic Authorization.
shard_id: Optional[:class:`int`]
- Integer starting at 0 and less than :attr:`.shard_count`.
+ Integer starting at ``0`` and less than :attr:`.shard_count`.
shard_count: Optional[:class:`int`]
The total number of shards.
fetch_offline_members: :class:`bool`
@@ -257,7 +257,7 @@ class Client:
@property
def user(self):
- """Optional[:class:`.ClientUser`]: Represents the connected client. None if not logged in."""
+ """Optional[:class:`.ClientUser`]: Represents the connected client. ``None`` if not logged in."""
return self._connection.user
@property
@@ -654,7 +654,7 @@ class Client:
@property
def allowed_mentions(self):
- """Optional[:class:`AllowedMentions`]: The allowed mention configuration.
+ """Optional[:class:`~discord.AllowedMentions`]: The allowed mention configuration.
.. versionadded:: 1.4
"""
@@ -999,7 +999,7 @@ class Client:
The number of guilds to retrieve.
If ``None``, it retrieves every guild you have access to. Note, however,
that this would make it a slow operation.
- Defaults to 100.
+ Defaults to ``100``.
before: Union[:class:`.abc.Snowflake`, :class:`datetime.datetime`]
Retrieves guilds before this date or object.
If a date is provided it must be a timezone-naive datetime representing UTC time.