Skip to content

Commit d134dc1

Browse files
committed
Complete 3.1 changelog
1 parent a339ac8 commit d134dc1

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/getting-started/changelog.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,26 @@ Changelog
1212
- twitchio
1313
- Additions
1414
- Added ``__hash__`` to :class:`twitchio.PartialUser` allowing it to be used as a key.
15+
- Added the ``--create-new`` interactive script to ``__main__`` allowing boiler-plate to be generated for a new Bot.
1516

1617
- Changes
1718
- Adjusted the Starlette logging warning wording.
19+
- Delayed the Starlette logging warning and removed it from ``web/__init__.py``.
1820
- :class:`twitchio.PartialUser`, :class:`twitchio.User` and :class:`twitchio.Chatter` now have ``__hash__`` implementations derived from :class:`~twitchio.PartialUser`, which use the unique ID.
1921

2022
- Bug fixes
2123
- :meth:`twitchio.Clip.fetch_video` now properly returns ``None`` when the :class:`twitchio.Clip` has no ``video_id``.
2224
- :class:`twitchio.ChatterColor` no longer errors whan no valid hex is provided by Twitch.
25+
- Some general typing/spelling errors cleaned up in Documentation and Logging.
26+
- Removed some redundant logging.
27+
28+
- twitchio.AutoClient
29+
- Additions
30+
- Added ``force_subscribe`` keyword argument to :class:`twitchio.AutoClient`, allowing subscriptions passed to be made everytime the client is started.
31+
32+
- twitchio.ext.commands.AutoBot
33+
- Additions
34+
- Added ``force_subscribe`` keyword argument to :class:`twitchio.ext.commands.AutoBot`, allowing subscriptions passed to be made everytime the bot is started.
2335

2436
- twitchio.eventsub
2537
- Additions
@@ -82,13 +94,35 @@ Changelog
8294
- Added :meth:`twitchio.ShoutoutReceive.respond`
8395
- Added :meth:`twitchio.StreamOnline.respond`
8496
- Added :meth:`twitchio.StreamOffline.respond`
97+
98+
- Bug fixes
99+
- Remove the unnecessary ``token_for`` parameter from :meth:`twitchio.eventsub.ChannelPointsReward.fetch_reward`. `#510 <https://github.com/PythonistaGuild/TwitchIO/pull/510>`_
100+
101+
- twitchio.web.AiohttpAdapter
102+
- Bug fixes
103+
- Fixed the redirect URL not allowing HOST/PORT when a custom domain was passed.
104+
- The redirect URL is now determined based on where the request came from.
105+
106+
- twitchio.web.StarletteAdapter
107+
- Bug fixes
108+
- Fixed the redirect URL not allowing HOST/PORT when a custom domain was passed.
109+
- The redirect URL is now determined based on where the request came from.
110+
- Fixed Uvicorn hanging the process when attempting to close the :class:`asyncio.Loop` on **Windows**.
111+
- After ``5 seconds`` Uvicorn will be forced closed if it cannot gracefully close in this time.
85112

86113
- ext.commands
87114
- Additions
115+
- Added :class:`~twitchio.ext.commands.Translator`
116+
- Added :func:`~twitchio.ext.commands.translator`
117+
- Added :attr:`twitchio.ext.commands.Command.translator`
118+
- Added :meth:`twitchio.ext.commands.Context.send_translated`
119+
- Added :meth:`twitchio.ext.commands.Context.reply_translated`
88120
- Added :class:`~twitchio.ext.commands.Converter`
89121
- Added :class:`~twitchio.ext.commands.UserConverter`
90122
- Added :class:`~twitchio.ext.commands.ColourConverter`
91123
- Added :class:`~twitchio.ext.commands.ColorConverter` alias.
124+
- Added :attr:`twitchio.ext.commands.Command.signature` which is a POSIX-like signature for the command.
125+
- Added :attr:`twitchio.ext.commands.Command.parameters` which is a mapping of parameter name to :class:`inspect.Parameter` associated with the command callback.
92126
- Added :attr:`twitchio.ext.commands.Command.help` which is the docstring of the command callback.
93127
- Added ``__doc__`` to :class:`~twitchio.ext.commands.Command` which takes from the callback ``__doc__``.
94128
- Added :meth:`twitchio.ext.commands.Command.run_guards`

0 commit comments

Comments
 (0)