Merge pull request #402 from tomschr/compare-258

Fix #258: Keep semver._deprecated.compare

CHANGELOG.rst

@@ -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
 
 
@@ -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
 --------

docs/api.rst

@@ -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
@@ -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