aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSkezza <[email protected]>2020-07-07 10:25:37 +0100
committerRapptz <[email protected]>2020-07-22 23:15:16 -0400
commit2552a268cb3bb2acf529239fa6578ff96feee286 (patch)
tree01d065bf67e27b581d97070cdf496d19117c9862
parentAdd Guild.change_voice_state to control our voice state. (diff)
downloaddiscord.py-2552a268cb3bb2acf529239fa6578ff96feee286.tar.xz
discord.py-2552a268cb3bb2acf529239fa6578ff96feee286.zip
Add double backticks for some parameter mentions in the documentation.
-rw-r--r--discord/guild.py2
-rw-r--r--discord/iterators.py28
-rw-r--r--discord/player.py4
3 files changed, 17 insertions, 17 deletions
diff --git a/discord/guild.py b/discord/guild.py
index cc2d5fa0..4a02cbd5 100644
--- a/discord/guild.py
+++ b/discord/guild.py
@@ -1961,7 +1961,7 @@ class Guild(Hashable):
Retrieve entries after this date or entry.
If a date is provided it must be a timezone-naive datetime representing UTC time.
oldest_first: :class:`bool`
- If set to ``True``, return entries in oldest->newest order. Defaults to True if
+ If set to ``True``, return entries in oldest->newest order. Defaults to ``True`` if
``after`` is specified, otherwise ``False``.
user: :class:`abc.Snowflake`
The moderator to filter entries from.
diff --git a/discord/iterators.py b/discord/iterators.py
index ad8828ff..cbb59e93 100644
--- a/discord/iterators.py
+++ b/discord/iterators.py
@@ -173,16 +173,16 @@ class HistoryIterator(_AsyncIterator):
"""Iterator for receiving a channel's message history.
The messages endpoint has two behaviours we care about here:
- If `before` is specified, the messages endpoint returns the `limit`
- newest messages before `before`, sorted with newest first. For filling over
- 100 messages, update the `before` parameter to the oldest message received.
+ If ``before`` is specified, the messages endpoint returns the `limit`
+ newest messages before ``before``, sorted with newest first. For filling over
+ 100 messages, update the ``before`` parameter to the oldest message received.
Messages will be returned in order by time.
- If `after` is specified, it returns the `limit` oldest messages after
- `after`, sorted with newest first. For filling over 100 messages, update the
- `after` parameter to the newest message received. If messages are not
+ If ``after`` is specified, it returns the ``limit`` oldest messages after
+ ``after``, sorted with newest first. For filling over 100 messages, update the
+ ``after`` parameter to the newest message received. If messages are not
reversed, they will be out of order (99-0, 199-100, so on)
- A note that if both before and after are specified, before is ignored by the
+ A note that if both ``before`` and ``after`` are specified, ``before`` is ignored by the
messages endpoint.
Parameters
@@ -200,7 +200,7 @@ class HistoryIterator(_AsyncIterator):
limit is an even number, this will return at most limit+1 messages.
oldest_first: Optional[:class:`bool`]
If set to ``True``, return messages in oldest->newest order. Defaults to
- True if ``after`` is specified, otherwise ``False``.
+ ``True`` if `after` is specified, otherwise ``False``.
"""
def __init__(self, messageable, limit,
@@ -462,16 +462,16 @@ class GuildIterator(_AsyncIterator):
The guilds endpoint has the same two behaviours as described
in :class:`HistoryIterator`:
- If `before` is specified, the guilds endpoint returns the `limit`
- newest guilds before `before`, sorted with newest first. For filling over
- 100 guilds, update the `before` parameter to the oldest guild received.
+ If ``before`` is specified, the guilds endpoint returns the ``limit``
+ newest guilds before ``before``, sorted with newest first. For filling over
+ 100 guilds, update the ``before`` parameter to the oldest guild received.
Guilds will be returned in order by time.
- If `after` is specified, it returns the `limit` oldest guilds after `after`,
- sorted with newest first. For filling over 100 guilds, update the `after`
+ If `after` is specified, it returns the ``limit`` oldest guilds after ``after``,
+ sorted with newest first. For filling over 100 guilds, update the ``after``
parameter to the newest guild received, If guilds are not reversed, they
will be out of order (99-0, 199-100, so on)
- Not that if both before and after are specified, before is ignored by the
+ Not that if both ``before`` and ``after`` are specified, ``before`` is ignored by the
guilds endpoint.
Parameters
diff --git a/discord/player.py b/discord/player.py
index 4384d9fd..cbfd000a 100644
--- a/discord/player.py
+++ b/discord/player.py
@@ -180,7 +180,7 @@ class FFmpegPCMAudio(FFmpegAudio):
------------
source: Union[:class:`str`, :class:`io.BufferedIOBase`]
The input that ffmpeg will take and convert to PCM bytes.
- If ``pipe`` is True then this is a file-like object that is
+ If ``pipe`` is ``True`` then this is a file-like object that is
passed to the stdin of ffmpeg.
executable: :class:`str`
The executable name (and path) to use. Defaults to ``ffmpeg``.
@@ -253,7 +253,7 @@ class FFmpegOpusAudio(FFmpegAudio):
------------
source: Union[:class:`str`, :class:`io.BufferedIOBase`]
The input that ffmpeg will take and convert to Opus bytes.
- If ``pipe`` is True then this is a file-like object that is
+ If ``pipe`` is ``True`` then this is a file-like object that is
passed to the stdin of ffmpeg.
bitrate: :class:`int`
The bitrate in kbps to encode the output to. Defaults to ``128``.