Fix #258: Keep semver._deprecated.compare#402
Merged
tomschr merged 1 commit intopython-semver:masterfrom Apr 2, 2023
Merged
Conversation
tomschr
added
Release_3.x.y
Although it breaks consistency with module level functions, it seems it's a much needed/used function. Nevertheless it's a "deprecated" function. * Function is also available accessing semver.compare() * Decorate semver.compare() as PendingDeprecationWarning * Update docstring of semver.compare() * Adapt `deprecated` decorator and use enforce keyword arguments * Update CHANGELOG.rst * Use intersphinx to link to Python exception, use Python inventory It's still unclear if we should deprecate this function or not (that's why we use PendingDeprecationWarning). As we don't have a uniform initializer yet, this function stays in _deprecated.py for the time being until we find a better soltuion. See python-semver#258 for details
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
1 participant
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.
This PR contains:
compare()into_deprecated.pyPendingDeprecationWarningwhen warnings are enableddeprecateddecorator and use enforce keyword arguments