summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorRaphaël Barrois <raphael.barrois@polyconseil.fr>2018-06-18 13:29:10 +0200
committerRaphaël Barrois <raphael.barrois@polyconseil.fr>2018-06-18 13:29:10 +0200
commit70ab67dd4c1823fa6fb1d4ec56c6373851b031a7 (patch)
tree6c9ef89aec137f2d14b214ec83acfac2f9436be9 /README.rst
parentbed41d6c9d6be1f35e5134e08b88c20f1772d364 (diff)
downloadsemantic-version-70ab67dd4c1823fa6fb1d4ec56c6373851b031a7.tar.gz
Improve docs on `next_patch()`.
Those functions had been forgotten in the docs. Clarify that `Version('1.0.1-alpha').next_patch()` is `Version('1.0.1')`, since that version is the smallest non-prerelease version greater than `Version('1.0.1-alpha')`. Closes: #67
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index c1d97d2..682a8c7 100644
--- a/README.rst
+++ b/README.rst
@@ -125,15 +125,15 @@ You can also get a new version that represents a bump in one of the version leve
.. code-block:: pycon
- >>> v = semantic_version.Version('0.1.1-pre+build')
+ >>> v = semantic_version.Version('0.1.1+build')
>>> new_v = v.next_major()
>>> str(new_v)
'1.0.0'
- >>> v = semantic_version.Version('1.1.1-pre+build')
+ >>> v = semantic_version.Version('1.1.1+build')
>>> new_v = v.next_minor()
>>> str(new_v)
'1.2.0'
- >>> v = semantic_version.Version('1.1.1-pre+build')
+ >>> v = semantic_version.Version('1.1.1+build')
>>> new_v = v.next_patch()
>>> str(new_v)
'1.1.2'