Skip to content

Commit a8bb4f8

Browse files
koteshyelamatikoteshyelamati
authored
fix: replace deprecated semver.parse() with semver.Version.parse() in docstrings (#471)
The docstrings in bump_major, bump_minor, bump_patch, bump_prerelease, bump_build, and next_version used semver.parse() which returns a plain dict, not a Version object. Calling instance methods like .bump_major() on a dict raises AttributeError. Replace all 6 occurrences with semver.Version.parse() which correctly returns a Version instance, making the doctests runnable and accurate.
1 parent 9c19156 commit a8bb4f8

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

‎src/semver/version.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ def bump_major(self) -> "Version":
289289
290290
:return: new object with the raised major part
291291
292-
>>> ver = semver.parse("3.4.5")
292+
>>> ver = semver.Version.parse("3.4.5")
293293
>>> ver.bump_major()
294294
Version(major=4, minor=0, patch=0, prerelease=None, build=None)
295295
"""
@@ -303,7 +303,7 @@ def bump_minor(self) -> "Version":
303303
304304
:return: new object with the raised minor part
305305
306-
>>> ver = semver.parse("3.4.5")
306+
>>> ver = semver.Version.parse("3.4.5")
307307
>>> ver.bump_minor()
308308
Version(major=3, minor=5, patch=0, prerelease=None, build=None)
309309
"""
@@ -317,7 +317,7 @@ def bump_patch(self) -> "Version":
317317
318318
:return: new object with the raised patch part
319319
320-
>>> ver = semver.parse("3.4.5")
320+
>>> ver = semver.Version.parse("3.4.5")
321321
>>> ver.bump_patch()
322322
Version(major=3, minor=4, patch=6, prerelease=None, build=None)
323323
"""
@@ -345,7 +345,7 @@ def bump_prerelease(
345345
:return: new :class:`Version` object with the raised prerelease part.
346346
The original object is not modified.
347347
348-
>>> ver = semver.parse("3.4.5")
348+
>>> ver = semver.Version.parse("3.4.5")
349349
>>> ver.bump_prerelease().prerelease
350350
'rc.1'
351351
>>> ver.bump_prerelease('').prerelease
@@ -380,7 +380,7 @@ def bump_build(self, token: Optional[str] = "build") -> "Version":
380380
:return: new :class:`Version` object with the raised build part.
381381
The original object is not modified.
382382
383-
>>> ver = semver.parse("3.4.5-rc.1+build.9")
383+
>>> ver = semver.Version.parse("3.4.5-rc.1+build.9")
384384
>>> ver.bump_build()
385385
Version(major=3, minor=4, patch=5, prerelease='rc.1', \
386386
build='build.10')
@@ -456,7 +456,7 @@ def next_version(self, part: str, prerelease_token: str = "rc") -> "Version":
456456
"prerelease" part. It gives you the next patch version of the
457457
prerelease, for example:
458458
459-
>>> str(semver.parse("0.1.4").next_version("prerelease"))
459+
>>> str(semver.Version.parse("0.1.4").next_version("prerelease"))
460460
'0.1.5-rc.1'
461461
462462
:param part: One of "major", "minor", "patch", or "prerelease"

0 commit comments

Comments
 (0)