matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Add double backticks for some parameter mentions in the documentation.

Browse Source
This commit is contained in:
Skezza 2020-07-07 10:25:37 +01:00 committed by Rapptz
parent 1ca257bb68
commit 2552a268cb
3 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
discord/guild.py
View File

@ -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.

28
discord/iterators.py
View File

@ -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

4
discord/player.py
View File

@ -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``.