aboutsummaryrefslogtreecommitdiff
path: root/discord/utils.py
diff options
context:
space:
mode:
authorNCPlayz <[email protected]>2019-03-16 21:43:55 +0000
committerRapptz <[email protected]>2019-03-19 08:24:42 -0400
commitfb02191b80972a9cf7c3baa765cb3aa84c6f1cfa (patch)
tree7a0a5c9aaa5cc5bac26fc51caf4fdffbaee64c26 /discord/utils.py
parentTake back ownership of files from aiohttp for retrying requests. (diff)
downloaddiscord.py-fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa.tar.xz
discord.py-fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa.zip
Organise documentation
Diffstat (limited to 'discord/utils.py')
-rw-r--r--discord/utils.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/discord/utils.py b/discord/utils.py
index 42789186..dc63f1d3 100644
--- a/discord/utils.py
+++ b/discord/utils.py
@@ -104,14 +104,14 @@ def oauth_url(client_id, permissions=None, guild=None, redirect_uri=None):
Parameters
-----------
- client_id : str
+ client_id: :class:`str`
The client ID for your bot.
- permissions : :class:`Permissions`
+ permissions: :class:`Permissions`
The permissions you're requesting. If not given then you won't be requesting any
permissions.
- guild : :class:`Guild`
+ guild: :class:`Guild`
The guild to pre-select in the authorization screen, if available.
- redirect_uri : str
+ redirect_uri: :class:`str`
An optional valid redirect URI.
"""
url = 'https://discordapp.com/oauth2/authorize?client_id={}&scope=bot'.format(client_id)
@@ -139,7 +139,7 @@ def time_snowflake(datetime_obj, high=False):
-----------
datetime_obj
A timezone-naive datetime object representing UTC time.
- high
+ high: :class:`bool`
Whether or not to set the lower 22 bit to high or low.
"""
unix_seconds = (datetime_obj - type(datetime_obj)(1970, 1, 1)).total_seconds()
@@ -166,7 +166,7 @@ def find(predicate, seq):
-----------
predicate
A function that returns a boolean-like result.
- seq : iterable
+ seq: iterable
The iterable to search through.
"""