diff options
author | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2016-02-12 01:18:15 +0100 |
---|---|---|
committer | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2016-02-12 01:19:45 +0100 |
commit | b923dfcdf9ea32072d49ff9f1527d8826327aef4 (patch) | |
tree | 5c6e44d98f9fa0befeac6f8a8d3ed634b0e7fcfd /docs | |
parent | 9f4ccad84b77b761f7e2032a8617a5b8d54d9008 (diff) | |
download | semantic-version-b923dfcdf9ea32072d49ff9f1527d8826327aef4.tar.gz |
Cleanup and document fixes from #31.
The PR was broken through fixed in ``next_minor()`` / ``next_major()``.
Diffstat (limited to 'docs')
-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 261e738..a645c1f 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 includes support for NPM-style specs: + + * ``~1.2.3`` means "Any release between 1.2.3 and 1.3.0" + * ``^1.3.4`` means "Any release between 1.3.4 and 2.0.0" + In order to force matches to *strictly* compare version numbers, these additional rules apply: @@ -307,6 +312,7 @@ rules apply: * ``<1.1.1+b1`` is invalid + .. class:: Spec(spec_string[, spec_string[, ...]]) Stores a list of :class:`SpecItem` and matches any :class:`Version` against all |