summaryrefslogtreecommitdiff
path: root/docs/reference.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference.rst')
-rw-r--r--docs/reference.rst6
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