diff options
| author | Martin Ek <mail@ekmartin.com> | 2016-03-07 13:15:14 +0100 |
|---|---|---|
| committer | Martin Ek <mail@ekmartin.com> | 2016-03-07 13:15:14 +0100 |
| commit | b08014a65eabfa8dfe372bdf0aa8195309f6e736 (patch) | |
| tree | 09881461ab57cb278cf54fffdb6f7ed446de2c84 | |
| parent | ec2c25cd3a46c53adbbdb411239043d237ad077f (diff) | |
| download | semantic-version-b08014a65eabfa8dfe372bdf0aa8195309f6e736.tar.gz | |
Add a doc section about compatible release clauses
| -rw-r--r-- | docs/reference.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/reference.rst b/docs/reference.rst index a645c1f..358b2c0 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -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 |