docs: add small note about version pinning #25
Closed
Conversation
This file contains 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
Signed-off-by: David Caro <david@dcaro.es>
kaplun
suggested changes
Nov 9, 2016
| @@ -30,6 +30,16 @@ User's Guide | |||
| This part of the documentation will show you how to get started in using | |||
| inspire-schemas. | |||
|
|
|||
| **NOTE**: is highly encouraged to pin the version of inspire-schemas that you | |||
| @@ -30,6 +30,16 @@ User's Guide | |||
| This part of the documentation will show you how to get started in using | |||
| inspire-schemas. | |||
|
|
|||
| **NOTE**: is highly encouraged to pin the version of inspire-schemas that you | |||
| use to the major number, for example using the `~=` version matcher in your | |||
| `requires.txt` or your `setup.py` like:: | |||
jacquerie
reviewed
Jan 5, 2017
| inspire-schemas~=1.1.0 | ||
|
|
||
| That will prevent any major update (compatibility breaking) to be pulled | ||
| automatically, and will only download minor and feature updates (1.X.Y). |
There was a problem hiding this comment.
Not according to PEP 440: https://www.python.org/dev/peps/pep-0440/#compatible-release
There was a problem hiding this comment.
Right. It will only upgrade to 1.1.X
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Signed-off-by: David Caro david@dcaro.es