All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
0.4.3 - 2024-11-24
- [tanchan.doc_parse][] now consistently supports both the
typing
andtyping_extensions
implementations of [typing.Unpack][] and [typing.TypedDict].
- Support for Python 3.9 and 3.10.
0.4.2 - 2024-10-07
- Support for Python 3.13.
0.4.1 - 2023-12-28
- Support for Python 3.12.
0.4.0 - 2023-08-28
- Configurable and optional help commands which display information about the loaded commands. These can be loaded from [tanchan.components.help][].
- Configurable and optional eval commands which let bot owners dynamically execute code in the bot's runtime. These can be loaded from [tanchan.components.eval][].
- The logic and builder for a stateless Yuyo button which lets command authors delete responses. This can be loaded from [tanchan.components.buttons][] and is used by the eval and help commands.
0.3.1 - 2023-07-26
- Support for the application command
nsfw
config option.
- Bumped the minimum Tanjun version to
2.16.0
.
0.3.0 - 2023-03-12
- [with_annotated_args][tanchan.doc_parse.with_annotated_args] will now also parse
option descriptions from the docstring of the typed dict being used as an
unpacked
**kwargs
type hint.
0.2.2.post - 2023-03-04
- [SlashCommandGroup.as_sub_command][tanchan.doc_parse.SlashCommandGroup.as_sub_command] now actually adds the created command to the group.
0.2.2 - 2023-03-03
- Extended [tanjun.SlashCommandGroup][] impl at [tanchan.doc_parse.SlashCommandGroup][]
where the
name
, anddescription
parameters are now optional and introspected from the callback's docstring by default for [SlashCommandGroup.as_sub_command][tanchan.doc_parse.SlashCommandGroup.as_sub_command]. [SlashCommandGroup.make_sub_group][tanchan.doc_parse.SlashCommandGroup.make_sub_group] also returns a [tanchan.doc_parse.SlashCommandGroup][] instance. - Optional
description
arg to [tanchan.doc_parse.as_slash_command][] to allow overriding the introspected value.
- [tanchan.doc_parse.as_slash_command][] is now typed to allow decorating commands which match the abstract types in [tanjun.abc][], not just the standard impls.
- A mapping of locales to values can now be passed for
name
to [tanchan.doc_parse.as_slash_command][].
0.2.1 - 2023-02-01
- Bumped the minimum Tanjun version to
v2.11.3
. - Updated the type-hints for [tanchan.doc_parse.as_slash_command][] to match changes to Tanjun.
0.2.0 - 2022-12-07
- Support for Sphinx style reST docs to doc parse.
- Optional
name
argument to [tanchan.doc_parse.as_slash_command][] which allows overriding the command's name.
- [tanchan.doc_parse.as_slash_command][] no-longer errors when the callback's
docstring is just the description and
doc_style
is [None][]. - [tanchan.doc_parse.with_annotated_args][] now allows [None][] to be explicitly
passed to
doc_style
typing wise.
0.1.0 - 2022-12-02
- An extension to [tanjun.annotations][] which allows for parsing slash command descriptions (including for options) from the command callback's docstring + using the callback's name as the command's name.