Skip to content

Commit 80a7ce4

Browse files
authored
Add release notes for v0.6.0 (#113)
1 parent 2ec2d20 commit 80a7ce4

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

docs/release_notes/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
:::{toctree}
44
:maxdepth: 1
55

6+
v0.6.0
67
v0.5.0
78
v0.4.0
89
v0.3.0

docs/release_notes/v0.6.0.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# docstub v0.6.0
2+
3+
We're happy to announce the release of docstub v0.6.0 on 2025-11-04!
4+
5+
## Enhancement
6+
7+
- 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)).
8+
- **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)).
9+
- Don't color output if the environment variable `NO_COLOR=1` is set ([#109](https://github.com/scientific-python/docstub/pull/109)).
10+
- 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)).
11+
- Provide file and line context in warnings that are emitted while parsing doctypes ([#108](https://github.com/scientific-python/docstub/pull/108)).
12+
- Add the short command line option `-g` as an alternative to `docstub run --group-errors` ([#109](https://github.com/scientific-python/docstub/pull/109)).
13+
- 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)).
14+
15+
## Performance
16+
17+
- 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)).
18+
19+
## Bug Fixes
20+
21+
- 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)).
22+
- 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)).
23+
- 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)).
24+
25+
## Contributors
26+
27+
1 author(s) added to this release (alphabetically):
28+
29+
- Lars Grüter ([@lagru](https://github.com/lagru))

0 commit comments

Comments
 (0)