fix: replace semver.parse() with semver.Version.parse() in docstrings#471
Merged
Conversation
… docstrings 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.
tomschr
approved these changes
Jul 5, 2026
tomschr
left a comment
tomschr
left a comment
Member
There was a problem hiding this comment.
Thank you @koteshyelamati for your contribution! 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Six docstrings in
version.pyusesemver.parse()which returns a plaindict, not aVersionobject:Affected methods:
bump_major,bump_minor,bump_patch,bump_prerelease,bump_build,next_version.Fix
Replace all 6 occurrences of
semver.parse()withsemver.Version.parse(), which correctly returns aVersioninstance and makes the doctests runnable and accurate.