From e873ddb2f6a3a0196bb6454565d531276e8d1c7f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Gr=C3=BCter?= Date: Tue, 4 Nov 2025 18:19:22 +0100 Subject: [PATCH] Add release notes for v0.6.0 --- docs/release_notes/index.md | 1 + docs/release_notes/v0.6.0.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 docs/release_notes/v0.6.0.md diff --git a/docs/release_notes/index.md b/docs/release_notes/index.md index 3700e70..f2864c1 100644 --- a/docs/release_notes/index.md +++ b/docs/release_notes/index.md @@ -3,6 +3,7 @@ :::{toctree} :maxdepth: 1 +v0.6.0 v0.5.0 v0.4.0 v0.3.0 diff --git a/docs/release_notes/v0.6.0.md b/docs/release_notes/v0.6.0.md new file mode 100644 index 0000000..f6f3bf0 --- /dev/null +++ b/docs/release_notes/v0.6.0.md @@ -0,0 +1,29 @@ +# docstub v0.6.0 + +We're happy to announce the release of docstub v0.6.0 on 2025-11-04! + +## Enhancement + +- Add the new experimental `--workers` option to `docstub run` to **generate stub files in parallel**. This can reduce runtime significantly for projects with many files. For now, multiprocessing has to be explicitly enabled by requesting a number of workers ([#110](https://github.com/scientific-python/docstub/pull/110)). +- **Highlight help messages** (invoked with `-h` or `--help`) of the command line interface with colors and reformat. This should improve the readability ([#109](https://github.com/scientific-python/docstub/pull/109)). +- Don't color output if the environment variable `NO_COLOR=1` is set ([#109](https://github.com/scientific-python/docstub/pull/109)). +- Support using types from the standard library module `types` directly without requiring configuration or imports for them ([#106](https://github.com/scientific-python/docstub/pull/106)). +- Provide file and line context in warnings that are emitted while parsing doctypes ([#108](https://github.com/scientific-python/docstub/pull/108)). +- Add the short command line option `-g` as an alternative to `docstub run --group-errors` ([#109](https://github.com/scientific-python/docstub/pull/109)). +- Hide additional debug information behind "verbosity 3" (`-vvv`). This makes the option `-vv` a bit more usable. Also use a more generally visible ANSI color for debug information (bright_black) ([#104](https://github.com/scientific-python/docstub/pull/104)). + +## Performance + +- Speed-up how fast docstub's command line displays help text with the `-h` or `--help` option ([#112](https://github.com/scientific-python/docstub/pull/112)). + +## Bug Fixes + +- Ensure that warnings are raised for partially documented signatures. Previously, no warning was raised for untyped parameters when at least one parameter was annotated ([#107](https://github.com/scientific-python/docstub/pull/107)). +- Ensure that docstub still returns a non-zero exit code when it is run with output completely disabled (`-qq`). The same applies when running docstub with `--quiet --fail-on-warnings` ([#110](https://github.com/scientific-python/docstub/pull/110)). +- Ensure that warnings are raised for undocumented parameters and attributes. Previously, no warning was raised for parameters and attributes when at least that were mentioned in a docstring, but didn't have a doctype ([#111](https://github.com/scientific-python/docstub/pull/111)). + +## Contributors + +1 author(s) added to this release (alphabetically): + +- Lars Grüter ([@lagru](https://github.com/lagru))