Related pr: #315

• Released
  2022-01-20

• Maintainer
  Tom Schraitle

Documentation: https://python-semver.rtfd.io/en/3.0.0-dev.3/
Full Changelog: 3.0.0-dev.2...3.0.0-dev.3

Bug Fixes

• #310: Rework API documentation. Follow a more “semi-manual” attempt and add
  auto directives into docs/api.rst.

Improved Documentation

• #312: Rework “Usage” section.

  • Rename VersionInfo to Version class, but keep the old name as alias
  • Remove semver. prefix in doctests to make examples shorter
  • Correct some references to dunder methods like __getitem__(), __gt__() etc.
  • Remove inconsistencies and mention module level function as deprecated and discouraged from using
  • Make empty super() call in semverwithvprefix.py example

• #315: Improve release procedure text

• #337: Improve documentation for semver max/min

Trivial/Internal Changes

• #309: Some (private) functions from the semver.version module has been changed.
  The following functions got renamed as it is only useful inside the Version class:

  • function semver.version.comparator got renamed to semver.version._comparator()
  • function semver.version.cmp got renamed to semver.version._cmp()

  The following functions got integrated into the Version class:

  • function semver.version._nat_cmd as a class method
  • function semver.version.ensure_str

• #313: Correct tox.ini for changelog entry to skip installation for semver. This should speed up the execution of towncrier.

• #316: Comparisons of Version class and other types return now a NotImplemented constant instead of a TypeError exception.

  The NotImplemented section of the Python documentation recommends returning this constant when comparing with __gt__, __lt__, and other comparison operators to “to indicate that the operation is not implemented with respect to the other type”.

• #319: Introduce stages in .travis.yml.

• #322: Switch from Travis CI to GitHub Actions.

• #347: Support Python 3.10 in GitHub Action and other config files.

• Start supporting Python 3.10

Contributors

(in alphabetical order)

• @mzjp2 (new contributor)
• @tlaferriere

Thanks to all! ❤️