From 40bdb0bdd16018ff2170afd52f91b94aa199e03f Mon Sep 17 00:00:00 2001 From: Tom Schraitle Date: Wed, 13 May 2020 17:59:41 +0200 Subject: [PATCH 1/2] Fix #252: Correct wrong str type in docstring Type should be VersionInfo instead of str in VersionInfo.bump_build and VersionInfo.bump_prerelease Co-authored-by: Thomas Laferriere --- semver.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/semver.py b/semver.py index c2697dd5..57610c5c 100644 --- a/semver.py +++ b/semver.py @@ -374,7 +374,7 @@ def bump_prerelease(self, token="rc"): :param token: defaults to 'rc' :return: new object with the raised prerelease part - :rtype: str + :rtype: :class:`VersionInfo` >>> ver = semver.VersionInfo.parse("3.4.5-rc.1") >>> ver.bump_prerelease() @@ -392,7 +392,7 @@ def bump_build(self, token="build"): :param token: defaults to 'build' :return: new object with the raised build part - :rtype: str + :rtype: :class:`VersionInfo` >>> ver = semver.VersionInfo.parse("3.4.5-rc.1+build.9") >>> ver.bump_build() From 3066f6ee2cd984186f8cc0560e29fb2b5ffd9bbf Mon Sep 17 00:00:00 2001 From: Tom Schraitle Date: Wed, 13 May 2020 18:18:32 +0200 Subject: [PATCH 2/2] Make rtype line in docstrings consistent Use :class: prefix for VersionInfo object --- semver.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/semver.py b/semver.py index 57610c5c..f08ce788 100644 --- a/semver.py +++ b/semver.py @@ -328,7 +328,7 @@ def bump_major(self): untouched. :return: new object with the raised major part - :rtype: VersionInfo + :rtype: :class:`VersionInfo` >>> ver = semver.VersionInfo.parse("3.4.5") >>> ver.bump_major() @@ -343,7 +343,7 @@ def bump_minor(self): untouched. :return: new object with the raised minor part - :rtype: VersionInfo + :rtype: :class:`VersionInfo` >>> ver = semver.VersionInfo.parse("3.4.5") >>> ver.bump_minor() @@ -358,7 +358,7 @@ def bump_patch(self): untouched. :return: new object with the raised patch part - :rtype: VersionInfo + :rtype: :class:`VersionInfo` >>> ver = semver.VersionInfo.parse("3.4.5") >>> ver.bump_patch()