Skip to content

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.

Sign up for GitHub

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
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This section covers the changes between major version 2 and version 3.
Version 3.0.0
=============

:Released: 2023-03-19
:Released: 2023-04-02
:Maintainer: Tom Schraitle


Expand Down Expand Up @@ -95,6 +95,14 @@ Deprecations
didn't cast many votes, the majority agreed to remove support for
Python 3.6.

* :pr:`402`: Keep :func:`semver.compare <semver._deprecated.compare>`.
Although it breaks consistency with module level functions, it seems it's
a much needed/used function. It's still unclear if we should deprecate
this function or not (that's why we use :py:exc:`PendingDeprecationWarning`).

As we don't have a uniform initializer yet, this function stays in the
:file:`_deprecated.py` file for the time being until we find a better solution. See :gh:`258` for details.


Features
--------
Expand Down
4 changes: 2 additions & 2 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Deprecated Functions in :mod:`semver._deprecated`

.. automodule:: semver._deprecated

.. autofunction:: semver._deprecated.compare

.. autofunction:: semver._deprecated.bump_build

.. autofunction:: semver._deprecated.bump_major
Expand All @@ -27,8 +29,6 @@ Deprecated Functions in :mod:`semver._deprecated`

.. autofunction:: semver._deprecated.bump_prerelease

.. autofunction:: semver._deprecated.compare

.. autofunction:: semver._deprecated.deprecated

.. autofunction:: semver._deprecated.finalize_version
Expand Down
Loading