Skip to content

Commit b6c0a2f

Browse files
committed
updated docs once again
1 parent e0fa8c5 commit b6c0a2f

File tree

3 files changed

+19
-17
lines changed

3 files changed

+19
-17
lines changed

docs/source/access_token.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ AccessToken
9696
:param bool mute: Wether they should be server muted when they join.
9797
:param bool deaf: Wether they should be server deafend when they join.
9898

99-
:returns: :class:`dict`
99+
:returns: dict
100100
:raises discordoauth2.exceptions.HTTPException: The request failed
101101
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.join scope or the bot isn't in the guild/have the correct permissions.
102102
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -111,7 +111,7 @@ AccessToken
111111

112112
.. versionadded:: 1.1
113113

114-
:returns: :class:`dict`
114+
:returns: dict
115115
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
116116
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
117117
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -126,7 +126,7 @@ AccessToken
126126
:param str platform_username: Text that appears under the platform name, large, and usally denoting the user's name on the platform.
127127
:param dict metadata: List of keys and values to set the user's metadata. Supported types: :class:`bool`, :class:`datetime.datetime`, :class:`int`
128128

129-
:returns: :class:`dict`
129+
:returns: dict
130130
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
131131
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
132132
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -141,7 +141,7 @@ AccessToken
141141

142142
.. versionadded:: 1.1
143143

144-
:returns: :class:`dict`
144+
:returns: dict
145145
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
146146
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
147147
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -184,7 +184,7 @@ AccessToken
184184

185185
Returns a dictionary with a `user object <https://discord.com/developers/docs/resources/user#user-object-user-structure>`__ which includes ``email`` and ``verified`` (verified email) if the ``email`` scope is provided
186186

187-
:returns: :class:`dict`
187+
:returns: dict
188188
:raises discordoauth2.exceptions.HTTPException: The request failed
189189
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the identify scope.
190190
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -193,7 +193,7 @@ AccessToken
193193

194194
Returns a list of `connection objects <https://discord.com/developers/docs/resources/user#connection-object-connection-structure>`__
195195

196-
:returns: :class:`list`
196+
:returns: list[dict]
197197
:raises discordoauth2.exceptions.HTTPException: The request failed
198198
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the connections scope.
199199
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -203,7 +203,7 @@ AccessToken
203203

204204
Returns a list of partial `guild objects <https://discord.com/developers/docs/resources/guild#guild-object>`__
205205

206-
:returns: :class:`list`
206+
:returns: list[dict]
207207
:raises discordoauth2.exceptions.HTTPException: The request failed
208208
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds scope.
209209
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -214,7 +214,7 @@ AccessToken
214214

215215
:param int guild_id: The guild ID to retrieve member data from.
216216

217-
:returns: :class:`dict`
217+
:returns: dict
218218
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
219219
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
220220
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -229,7 +229,7 @@ AccessToken
229229
:param bool mute: Wether they should be server muted when they join.
230230
:param bool deaf: Wether they should be server deafend when they join.
231231

232-
:returns: :class:`dict`
232+
:returns: dict
233233
:raises discordoauth2.exceptions.HTTPException: The request failed
234234
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.join scope or the bot isn't in the guild/have the correct permissions.
235235
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -240,7 +240,7 @@ AccessToken
240240

241241
.. versionadded:: 1.1
242242

243-
:returns: :class:`dict`
243+
:returns: dict
244244
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
245245
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
246246
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -255,7 +255,7 @@ AccessToken
255255
:param str platform_username: Text that appears under the platform name, large, and usally denoting the user's name on the platform.
256256
:param dict metadata: List of keys and values to set the user's metadata. Supported types: :class:`bool`, :class:`datetime.datetime`, :class:`int`
257257

258-
:returns: :class:`dict`
258+
:returns: dict
259259
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
260260
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
261261
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -270,7 +270,7 @@ AccessToken
270270

271271
.. versionadded:: 1.1
272272

273-
:returns: :class:`dict`
273+
:returns: dict
274274
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
275275
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
276276
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.

docs/source/client.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Client
1212

1313
.. attribute:: id
1414

15-
The application ID
15+
The application's ID
1616

1717
:type: int
1818

@@ -42,7 +42,7 @@ Client
4242

4343
.. method:: refresh_token(refresh_token)
4444

45-
Converts a refresh token into a new `AccessToken`. You should store the refresh token and access token, so you can renew the access token when it expires.
45+
Converts a refresh token into a new :class:`discordoauth2.AccessToken`. You should store the refresh token and access token, so you can renew the access token when it expires.
4646

4747
:param str refresh_token: The refresh token, can be found from :attr:`discordoauth2.AccessToken.refresh_token`
4848

@@ -52,7 +52,7 @@ Client
5252

5353
.. method:: client_credentails_grant(scope)
5454

55-
Creates an `AccessToken` on behalf of the application's owner.
55+
Creates an :class:`discordoauth2.AccessToken` on behalf of the application's owner.
5656

5757
:param list[str] scope: List of scopes.
5858

@@ -62,7 +62,7 @@ Client
6262

6363
.. warning::
6464

65-
If the application is owned by a team, you can only request for the `identify` scope. You can also request `applications.commands.update`, but the library does not support it yet.
65+
If the application is owned by a team, you can only request for the ``identify`` scope. You can also request ``applications.commands.update`, but the library does not support it yet.``
6666

6767
.. method:: revoke_token(token, token_type=None)
6868

@@ -82,7 +82,7 @@ Client
8282

8383
.. versionadded:: 1.1
8484

85-
:param dict metadata: Should be a list of `application role connection metadata<https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object>`__
85+
:param dict metadata: Should be a list of `application role connection metadata <https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object>`__
8686

8787
.. note::
8888

docs/source/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Table of Contents
66

77
.. toctree::
88

9+
:maxdepth: 2
10+
911
client
1012
access_token
1113

0 commit comments

Comments
 (0)