summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRaphaël Barrois <raphael.barrois@polytechnique.org>2020-04-29 11:46:24 +0200
committerRaphaël Barrois <raphael.barrois@polytechnique.org>2020-04-29 11:46:24 +0200
commit0811fca1c435c1477ee1465578580b491cba6c73 (patch)
treed83ce16c1b5fa1d6a8ee76a0248a9d77f9aedbb8 /docs
parenteda1ac8c22a99dbd01cd57fbcd459856b469ae46 (diff)
downloadsemantic-version-0811fca1c435c1477ee1465578580b491cba6c73.tar.gz
Fix wildcard matching for SimpleSpec.
Including docs and tests. Closes #98.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/reference.rst b/docs/reference.rst
index da08a22..951bd9a 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -472,6 +472,15 @@ Each of those ``Spec`` classes provides a shared set of methods to work with ver
* A clause of ``>0.1.2-rc.3`` will match versions strictly above ``0.1.2-rc.3``, including matching prereleases of ``0.1.2``: ``0.1.2-rc.10`` is included;
* A clause of ``>=XXX`` will match versions that match ``>XXX`` or ``==XXX``
+ ..rubric:: Wildcards
+
+ * A clause of ``==0.1.*`` is equivalent to ``>=0.1.0,<0.2.0``
+ * A clause of ``>=0.1.*`` is equivalent to ``>=0.1.0``
+ * A clause of ``==1.*`` or ``==1.*.*`` is equivalent to ``>=1.0.0,<2.0.0``
+ * A clause of ``>=1.*`` or ``>=1.*.*`` is equivalent to ``>=1.0.0``
+ * A clause of ``==*`` maps to ``>=0.0.0``
+ * A clause of ``>=*`` maps to ``>=0.0.0``
+
.. rubric:: Extensions
Additionnally, python-semanticversion supports extensions from specific packaging platforms: