Document constraints.txt usage. #585
Merged
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
obestwalter
reviewed
Aug 23, 2017
doc/example/basic.txt
Outdated
|
|
||
| .. versionadded:: 1.6.1 | ||
|
|
||
| (experimental) If you have a ``constrains.txt`` file you can add it to your ``deps``varaiable like this:: |
obestwalter
reviewed
Aug 23, 2017
doc/example/basic.txt
Outdated
|
|
||
| (experimental) If you have a ``constrains.txt`` file you can add it to your ``deps``varaiable like this:: | ||
|
|
||
| deps = constrains.txt |
There was a problem hiding this comment.
This would have to be deps = -cconstrains.txt
|
Hi @loechel thanks for the PR. I guess you mean this: https://pip.pypa.io/en/stable/user_guide/#constraints-files? If yes: this is nothing that is implemented as such - it is basically a side effect of the way how deps is implemented. deps passes the Maybe it would be better to explain that in above section documenting |
obestwalter
changed the title
obestwalter
reviewed
Aug 23, 2017
CHANGELOG
Outdated
| @@ -9,6 +9,7 @@ Not released yet | |||
| - #518: Forward `USERPROFILE` by default on Windows. | |||
| - #515: Don't require environment variables in test environments | |||
| where they are not used. | |||
| - : Add documentation for constrains.txt | |||
|
@obestwalter thanks for the feedback, I have adjusted the documentation. I hope it is better now and ready to merge. |
Closed
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.
I have documented the corresponding constrains.txt usage with tox, as it work similar to requirements.txt but was not documented.
Here's a quick checklist of what we'd like you to think off:
CONTRIBUTORS;