openstack/deb-python-semantic-version
Code Issues Proposed changes

Add a doc section about compatible release clauses

Browse Source
This commit is contained in:
Martin Ek
2016-03-07 13:15:14 +01:00
parent ec2c25cd3a
commit b08014a65e
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference.rst
View File

@@ -277,6 +277,11 @@ This means that::
.. note:: python-semanticversion also accepts ``"*"`` as a version spec,
that matches all (valid) version strings.
.. note:: python-semanticversion supports PyPI-style `compatible release clauses`_:
* ``~=2.2`` means "Any release between 2.2.0 and 3.0.0"
* ``~=1.4.5`` means "Any release between 1.4.5 and 1.5.0"
.. note:: python-semanticversion includes support for NPM-style specs:
* ``~1.2.3`` means "Any release between 1.2.3 and 1.3.0"
@@ -568,3 +573,4 @@ rules apply:
.. _SemVer: http://semver.org/
.. _`compatible release clauses`: https://www.python.org/dev/peps/pep-0440/#compatible-release