docs: loosen quickstart version pin to 0.4.x range#10
Merged
Conversation
Quickstart was pinned to elume==0.4.0. Users following the doc would miss patch releases (including security fixes) within the 0.4.x line. Loosen to >=0.4.0,<0.5 so the next 0.4.x release picks up automatically while preventing accidental jump to a 0.5.x that may change the public API.
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
1 participant
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.
Summary
docs/quickstart.md:25pinned readers toelume==0.4.0. Anyone following the doc would miss patch releases (including any future security patches) within the 0.4.x line.elume>=0.4.0,<0.5so the next 0.4.x release picks up automatically while preventing accidental jump to a 0.5.x that may change the public API the example depends on.elume==0.4.0on purpose: that example illustrates the practice of exact pinning for downstream projects' own pyproject.toml, where the consumer manages upgrades.Test plan
pytest tests/— 1194 passedpipsyntax:pip install "elume>=0.4.0,<0.5"Follows up on the security review from PR #9.