Fix #252: Correct wrong str type in docstring (#253)

tomschr · tlaferriere · web-flow · commit 1f0d49b33e22 · 2020-05-13T20:21:37.000+02:00
* Type should be VersionInfo instead of str in
  VersionInfo.bump_build and VersionInfo.bump_prerelease
* Make rtype line in docstrings consistent
* Use :class: prefix for VersionInfo object

Co-authored-by: Thomas Laferriere &lt;tlaferriere@users.noreply.github.com&gt;
diff --git 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()
@@ -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()
