Add docs showing pip-tools usage on dependencies #9158
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
This will help users not have random jinja or docutils updates break their builds. Fixes #9039
agjohnson
reviewed
May 2, 2022
Comment on lines
162
to
164
| .. code-block:: yaml | ||
|
|
||
| # File: docs/environment.yaml |
There was a problem hiding this comment.
Also :caption: here as well.
humitos
reviewed
May 3, 2022
There was a problem hiding this comment.
This is a good recommendation, I'm 👍🏼 on merging it.
However, I think the "Pinning transitive dependencies" section that you are adding is very similar to the previous one "Pinning dependencies" that does not pin transitive dependencies. So, I'd say that we should either:
- refer to the previous section communicating that pinning all the versions, including transitive dependencies is better than the previous section but it implies an extra step
- merge the two sections into one and only recommend pinning with pip-tools
Besides, this new section does not have a " Bad" subsection as the other have.
Co-authored-by: Anthony <[email protected]>
|
Yea, there's definitely some additional things to work on here, this is just a basic start that gets the info to our users when we link to this page. I agree that the previous section covers this, which I refer to in the first sentence. |
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.
This will help users not have random jinja or docutils updates break their builds.
Fixes #9039