aboutsummaryrefslogtreecommitdiff
path: root/discord/iterators.py
diff options
context:
space:
mode:
authorNCPlayz <[email protected]>2019-05-18 06:04:54 -0400
committerRapptz <[email protected]>2019-06-07 19:27:46 -0400
commit3c9bcc285147154a2980f6e661efdfa676672b6a (patch)
tree657bafa75e4e0d45361e394443ea932ad70e86a7 /discord/iterators.py
parentAdded comment for/redo system information (diff)
downloaddiscord.py-3c9bcc285147154a2980f6e661efdfa676672b6a.tar.xz
discord.py-3c9bcc285147154a2980f6e661efdfa676672b6a.zip
Improve documentation
Diffstat (limited to 'discord/iterators.py')
-rw-r--r--discord/iterators.py16
1 files changed, 8 insertions, 8 deletions
diff --git a/discord/iterators.py b/discord/iterators.py
index 68a98a03..17c11fbe 100644
--- a/discord/iterators.py
+++ b/discord/iterators.py
@@ -191,16 +191,16 @@ class HistoryIterator(_AsyncIterator):
Messageable class to retrieve message history from.
limit: :class:`int`
Maximum number of messages to retrieve
- before: :class:`abc.Snowflake`
+ before: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]
Message before which all messages must be.
- after: :class:`abc.Snowflake`
+ after: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]
Message after which all messages must be.
- around: :class:`abc.Snowflake`
+ around: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]
Message around which all messages must be. Limit max 101. Note that if
limit is an even number, this will return at most limit+1 messages.
- oldest_first: :class:`bool`
- If set to true, return messages in oldest->newest order. Defaults to
- True if ``after`` is specified, otherwise False.
+ oldest_first: Optional[:class:`bool`]
+ If set to ``True``, return messages in oldest->newest order. Defaults to
+ True if ``after`` is specified, otherwise ``False``.
"""
def __init__(self, messageable, limit,
@@ -482,9 +482,9 @@ class GuildIterator(_AsyncIterator):
The client to retrieve the guilds from.
limit: :class:`int`
Maximum number of guilds to retrieve.
- before: :class:`Snowflake`
+ before: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]
Object before which all guilds must be.
- after: :class:`Snowflake`
+ after: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]
Object after which all guilds must be.
"""
def __init__(self, bot, limit, before=None, after=None):