release: 0.5.0 - #15
Merged
Merged
Conversation
Plain-string options now emit DeprecationWarning. Nothing else changes and no numerical results move. This is the release 1.0.0 was waiting on: the policy is that anything removed in a major release warns for at least one minor release first, so strings could not be removed until this shipped. Verified from the built wheel in a clean environment: numpy alone, enums train under -W error::DeprecationWarning without warning, and a plain string warns.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Version bump and changelog for 0.5.0. One change, no results move.
What it is
Plain-string options now emit
DeprecationWarning:That is the whole release. Deliberately single-purpose, so the one behaviour change is easy to see
and easy to revert if it turns out to be noisy in practice.
Why it has to exist
1.0.0 was blocked on it. The stated policy is that anything removed in a major release warns for
at least one minor release first. 0.4.0 deprecated strings in writing only, because
mode="batch"was what every documentation page showed at the time. Without this release, 1.0.0 removing strings
would breach the policy the project set for itself.
Nothing else moves
No numerical change, no API removal, no dependency change. Anything that worked in 0.4.0 works here
and produces identical output. The only observable difference is the warning, which names the exact
replacement so migrating is a substitution you read off the message.
To silence it while migrating:
Verified from the built wheel
Plus 384 tests at 100% coverage, ruff /
ruff format/mypy --strictclean,mkdocs build --strictexits 0,twine checkpasses both artifacts.After merge
Tag
v0.5.0, then the workflow builds and waits on thepypienvironment's required reviewer. Theupload is irreversible — I will ask before approving it.