diff --git a/docs/development/release.md b/docs/development/release.md index e7d8c98..cf0acc8 100644 --- a/docs/development/release.md +++ b/docs/development/release.md @@ -11,18 +11,18 @@ Generate a [read-only GitHub token](https://github.com/settings/personal-access- ```shell pip install changelist -RELEASE_TAG=... -PREV_TAG=... +RELEASE_TAG=... # like 1.1.0 (without `v` prefix) +PREV_TAG=... # like v1.0.0 export GH_TOKEN=... changelist scientific-python/docstub \ --version "${RELEASE_TAG}" \ - --out "doc/release_notes/v${RELEASE_TAG}.md" \ + --out "docs/release_notes/v${RELEASE_TAG}.md" \ "${PREV_TAG}" main ``` -- `RELEASE_TAG` is the tag of the current release (for example `v1.1.0`) -- `PREV_TAG` is the tag of the previous release (for example `v1.0.0`). +- `RELEASE_TAG` is the tag of the current release +- `PREV_TAG` is the tag of the previous release So changelist will generate notes based on the changes between `${PREV_TAG}..main`. diff --git a/docs/release_notes/v0.6.0.md b/docs/release_notes/v0.6.0.md index 9e5dfe0..424ea03 100644 --- a/docs/release_notes/v0.6.0.md +++ b/docs/release_notes/v0.6.0.md @@ -1,6 +1,6 @@ # docstub 0.6.0 -We're happy to announce the release of docstub v0.6.0 on 2025-11-04! +We're happy to announce the release of docstub 0.6.0 on 2025-11-04! ## Enhancement diff --git a/docs/release_notes/v0.7.0.md b/docs/release_notes/v0.7.0.md index 9a634ee..2212a54 100644 --- a/docs/release_notes/v0.7.0.md +++ b/docs/release_notes/v0.7.0.md @@ -1,33 +1,46 @@ -# docstub pre-release 0.7.0rc0 +# docstub 0.7.0rc1 -Notes for the pre-release of docstub 0.7.0rc0 on 2026-01-19. +Notes for the pre-release of docstub 0.7.0rc1 on 2026-11-??. ## Enhancement -- Add support for callable expressions like `Callable[[int, str], int]` in doctypes ([#123](https://github.com/scientific-python/docstub/pull/123)). +- **Include shape information when translating doctypes** to annotations with `numpy.typing.NDArray`. This includes support for shapes with optional dimensions which use expansion like in the plugin example to create a union of arrays – one for each supported rank. Shapes with "..." are treated as an unspecified number of dimensions and are to `tuple[Any, ...]`. Empty shapes are supported too ([#132](https://github.com/scientific-python/docstub/pull/132)). +- **Add a new plugin system** to Docstub with 2 hooks. These hooks allow overriding/extending the default grammar and transformer that are used to transform doctypes into annotations. Add a minimal guide and documentation too ([#130](https://github.com/scientific-python/docstub/pull/130)). +- Support for callable expressions like `Callable[[int, str], int]` in doctypes ([#123](https://github.com/scientific-python/docstub/pull/123)). - Ensure that sources (file paths and line numbers) in command line output are sorted "naturally". For example `foo.py:9` should go before `foo.py:24` ([#119](https://github.com/scientific-python/docstub/pull/119)). - Log warnings emitted while parsing docstrings with NumPyDoc and link to the file and line number of the docstring ([#55](https://github.com/scientific-python/docstub/pull/55)). +- Color debug information with "green" which might be more visible with different color schemes than the previous "bright_black" ([#124](https://github.com/scientific-python/docstub/pull/124)). +- When printing debugging information (`-vv`), include command line arguments and the fully merged configuration in the output ([#124](https://github.com/scientific-python/docstub/pull/124)). +- Declare (official) support for Python 3.15 ([#128](https://github.com/scientific-python/docstub/pull/128)). + ## Performance - Avoid overusing libcst's "slower" `findall` ([#121](https://github.com/scientific-python/docstub/pull/121)). +- Cache transformed doctypes in each worker. Aggregated cache statistics are printed when showing debug information (`-vv` option) ([#130](https://github.com/scientific-python/docstub/pull/130)). ## Bug Fixes - Add support for expressions like `Literal[1, "some string"]` in doctypes. The grammar previously only allowed names inside this form ([#55](https://github.com/scientific-python/docstub/pull/55)). +- Expand arrays whose dtype is a union of dtypes into a union of arrays, one for each given dtype. This might be necessary if `numpy.typing.dtype` does not support unions as arguments ([#132](https://github.com/scientific-python/docstub/pull/132)). +- Strip shape and dtype from *ArrayLikes* when converting them to an annotation since `numpy.typing.ArrayLike` doesn't support adding that information ([#132](https://github.com/scientific-python/docstub/pull/132)). ## Documentation - Add contribution, release and style guides ([#103](https://github.com/scientific-python/docstub/pull/103)). - Update README after merging contributing guide ([#120](https://github.com/scientific-python/docstub/pull/120)). +- Add HTML documentation for docstub's Python API, including source links to the repository ([#129](https://github.com/scientific-python/docstub/pull/129)). ## DevOps - Bump actions/checkout from 5 to 6 in the actions group ([#117](https://github.com/scientific-python/docstub/pull/117)). +- Bump the actions group across 1 directory with 3 updates ([#126](https://github.com/scientific-python/docstub/pull/126)). ## Maintenance - Uncouple doctype transformation from name resolution ([#55](https://github.com/scientific-python/docstub/pull/55)). +- Align with supertype of click's HelpFormatter ([#127](https://github.com/scientific-python/docstub/pull/127)). +- Tweak logging messages in case a missing section title leads to multiple parameters with empty names being parsed by NumPyDoc in the 'Returns' section ([#134](https://github.com/scientific-python/docstub/pull/134)). ## Contributors diff --git a/pyproject.toml b/pyproject.toml index f9e3a1c..56f7019 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -44,7 +44,7 @@ dependencies = [ ] [project.urls] -Source = "https://github.com/lagru/docstub" +Source = "https://github.com/scientific-python/docstub" Documentation = "https://docstub.readthedocs.io" [project.scripts]