Skip to content

Commit a63407c

Browse files
committed
Fix some Client docs
1 parent f81a0bb commit a63407c

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

twitchio/client.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ class Client:
7676
7777
The `Client` acts as an entry point to the Twitch API, EventSub and OAuth and serves as a base for chat-bots.
7878
79-
:class:`commands.Bot` inherits from this class and such should be treated as a `Client` with an in-built
79+
:class:`twitchio.ext.commands.Bot` inherits from this class and such should be treated as a `Client` with an in-built
8080
commands extension.
8181
8282
You don't need to :meth:`~.start` or :meth:`~.run` the `Client` to use it soley as a HTTP Wrapper,
@@ -95,8 +95,10 @@ class Client:
9595
It is highly recommended setting this parameter as it will allow TwitchIO to use the bot's own tokens where
9696
appropriate and needed.
9797
redirect_uri: str | None
98-
An optional `str` to set as the redirect uri for anything relating to Twitch OAuth. You most often do not need to set
99-
this.
98+
An optional ``str`` to set as the redirect uri for anything relating to
99+
Twitch OAuth via :class:`twitchio.web.StarletteAdapter` or :class:`twitchio.web.AiohttpAdapter.
100+
This is a convenience attribute, it is preferred you
101+
use a custom :class:`twitchio.web.StarletteAdapter` or :class:`twitchio.web.AiohttpAdapter instead.
100102
scopes: twitchio.Scopes | None
101103
An optional :class:`~twitchio.Scopes` object to use as defaults when using anything related to Twitch OAuth.
102104
@@ -105,13 +107,11 @@ class Client:
105107
An optional :class:`aiohttp.ClientSession` to use for all HTTP requests including any requests made with
106108
:class:`~twitchio.Asset`'s.
107109
adapter: twitchio.StarletteAdapter | twitchio.AiohttpAdapter | None
108-
An optional :class:`StarletteAdapter` or :class:`twitchio.AiohttpAdapter` to use as the clients web server adapter.
110+
An optional :class:`twitchio.web.StarletteAdapter` or :class:`twitchio.web.AiohttpAdapter` to use as the clients web server adapter.
109111
110112
The adapter is a built-in webserver used for OAuth and when needed for EventSub over Webhooks.
111113
112-
When this is not provided, it will default to a :class:`twitchio.AiohttpAdapter` with default settings.
113-
114-
When requiring an adapter for use with EventSub, you must provide an adapter with the correct settings set.
114+
When this is not provided, it will default to a :class:`twitchio.web.AiohttpAdapter` with default settings.
115115
fetch_client_user: bool
116116
An optional bool indicating whether to fetch and cache the client/bot accounts own :class:`.User` object to use with
117117
:attr:`.user`.

0 commit comments

Comments
 (0)