mirror of
https://github.com/yawaflua/Flask-Discord.git
synced 2025-12-10 04:19:31 +02:00
Docs fixes
This commit is contained in:
@@ -9,7 +9,8 @@ from requests_oauthlib import OAuth2Session
|
||||
|
||||
class DiscordOAuth2HttpClient(abc.ABC):
|
||||
"""An OAuth2 http abstract base class providing some factory methods.
|
||||
This class is meant to be overridden by flask_discord.DiscordOAuth2Session class.
|
||||
This class is meant to be overridden by :py:class:`flask_discord.DiscordOAuth2Session`
|
||||
and should not be used directly.
|
||||
|
||||
Attributes
|
||||
----------
|
||||
@@ -75,8 +76,7 @@ class DiscordOAuth2HttpClient(abc.ABC):
|
||||
Parameters
|
||||
----------
|
||||
route : str
|
||||
Route or endpoint URL to send HTTP GET request to.
|
||||
Example: ``/users/@me``
|
||||
Route or endpoint URL to send HTTP GET request to. Example: ``/users/@me``
|
||||
|
||||
Returns
|
||||
-------
|
||||
|
||||
@@ -7,7 +7,7 @@ class DiscordOAuth2Session(_http.DiscordOAuth2HttpClient):
|
||||
"""Main client class representing hypothetical OAuth2 session with discord.
|
||||
It uses Flask `session <http://flask.pocoo.org/docs/1.0/api/#flask.session>`_ local proxy object
|
||||
to save state, authorization token and keeps record of users sessions across different requests.
|
||||
This class inherits flask_discord._http.DiscordOAuth2HttpClient class which
|
||||
This class inherits :py:class:`flask_discord._http.DiscordOAuth2HttpClient` class.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
||||
Reference in New Issue
Block a user