diff options
author | Raphaël Barrois <raphael.barrois@polyconseil.fr> | 2018-06-18 13:29:10 +0200 |
---|---|---|
committer | Raphaël Barrois <raphael.barrois@polyconseil.fr> | 2018-06-18 13:29:10 +0200 |
commit | 70ab67dd4c1823fa6fb1d4ec56c6373851b031a7 (patch) | |
tree | 6c9ef89aec137f2d14b214ec83acfac2f9436be9 /docs | |
parent | bed41d6c9d6be1f35e5134e08b88c20f1772d364 (diff) | |
download | semantic-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 'docs')
-rw-r--r-- | docs/reference.rst | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/reference.rst b/docs/reference.rst index 358b2c0..7c91200 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -122,6 +122,55 @@ Representing a version (the Version class) .. rubric:: Methods + .. method:: next_major(self) + + Return the next major version, i.e the smallest version strictly greater + than the current one with minor and patch set to 0 and no prerelease/build. + + .. code-block:: pycon + + >>> Version('1.0.2').next_major() + Version('2.0.0') + >>> Version('1.0.0+b3').next_major() + Version('2.0.0') + >>> Version('1.0.0-alpha').next_major() + Version('1.0.0') + + .. method:: next_minor(self) + + Return the next minor version, i.e the smallest version strictly greater + than the current one, with a patch level of ``0``. + + .. code-block:: pycon + + >>> Version('1.0.2').next_minor() + Version('1.1.0') + >>> Version('1.0.0+b3').next_minor() + Version('1.1.0') + >>> Version('1.1.2-alpha').next_minor() + Version('1.2.0') + >>> Version('1.1.0-alpha').next_minor() + Version('1.1.0') + + .. method:: next_patch(self): + + Return the next patch version, i.e the smallest version strictly + greater than the current one with empty :attr:`prerelease` and :attr:`build`. + + .. code-block:: pycon + + >>> Version('1.0.2').next_patch() + Version('1.0.3') + >>> Version('1.0.2+b3').next_patch() + Version('1.0.3') + >>> Version('1.0.2-alpha').next_patch() + Version('1.0.2') + + .. warning:: The next patch version of a version with a non-empty + :attr:`prerelease` is the version without that + :attr:`prerelease` component: it's the smallest "pure" + patch version strictly greater than that version. + .. method:: __iter__(self) Iterates over the version components (:attr:`major`, :attr:`minor`, |