Update docs for tilde-equals in package versions #5650
Merged
Conversation
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
matteius
reviewed
Apr 12, 2023
| $ pipenv install requests~=1.1 | ||
|
|
||
| Pipenv will install version `1.2` and any minor update, but not `2.0`. | ||
| Pipenv will install version `1.2` as it is a minor update, but not `2.0`. |
There was a problem hiding this comment.
I wonder if we should also provide an example of using tilde to allow updating the major version, example ~1 would allow upgrading to I guess, anything? It seems like a strange use case now that I mention it.
There was a problem hiding this comment.
I have added an example that allows micro version updates. Which would be more common usecase.
I dont think we need an example for updating major version.
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.
The issue
Fixes #5594
The fix
Added clarity to the example about tilde-equals operator for package versions
The checklist
news/directory to describe this fix with the extension.bugfix.rst,.feature.rst,.behavior.rst,.doc.rst..vendor.rst. or.trivial.rst(this will appear in the release changelog). Use semantic line breaks and name the file after the issue number or the PR #.