Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Fix #258: Keep semver._deprecated.compare #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 2, 2023

Conversation

tomschr
Copy link
Member

@tomschr tomschr commented Apr 2, 2023

This PR contains:

  • Move compare() into _deprecated.py
  • Update docstring of semver.compare() and mention the uncertainty of this function
  • Raise PendingDeprecationWarning when warnings are enabled
  • Adapt deprecated decorator and use enforce keyword arguments
  • Use intersphinx to link to Python exception; add Python inventory

@tomschr tomschr added Release_3.x.y Only for the major release 3 Enhancement Not a bug, but increases or improves in value, quality, desirability, or attractiveness Design Ideas, suggestions, musings about design questions labels Apr 2, 2023
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
@tomschr tomschr marked this pull request as ready for review April 2, 2023 12:29
@tomschr tomschr merged commit 5abeda6 into python-semver:master Apr 2, 2023
@tomschr tomschr deleted the compare-258 branch April 2, 2023 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Design Ideas, suggestions, musings about design questions Enhancement Not a bug, but increases or improves in value, quality, desirability, or attractiveness Release_3.x.y Only for the major release 3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
Morty Proxy This is a proxified and sanitized view of the page, visit original site.