Better explain role of existing requirements.txt
#1369
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
Codecov Report
@@ Coverage Diff @@
## master #1369 +/- ##
=======================================
Coverage 99.67% 99.67%
=======================================
Files 33 33
Lines 3037 3037
Branches 327 327
=======================================
Hits 3027 3027
Misses 5 5
Partials 5 5 Continue to review full report at Codecov.
|
atugushev
reviewed
Mar 31, 2021
This commit adds an explanation of the role of existing requirements.txt files to the README. I found this very unclear and opened #1358 because of my confusion. The existing short note that requirements.txt "might interfere" didn't really help me. I'm not sure how common my confusion is, but I hope my changes makes things clearer to new users (assuming what I've written is in fact correct!) (In addition to my additions, I moved the "Updating requirements" section up in the doc, since it seems like a core workflow.)
|
Thanks @mikepqr 🙏🏻 |
|
Thank you for your help! |
atugushev
changed the title
requirements.txt
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 commit adds an explanation of the role of existing requirements.txt
files to the README.
I found this very unclear and opened #1358 because of my confusion. The
existing short note that requirements.txt "might interfere" didn't
really help me. I'm not sure how common my confusion is, but I hope my
changes makes things clearer to new users (assuming what I've written is
in fact correct!)
(In addition to my additions, I moved the "Updating requirements"
section up in the doc, since it seems like a core workflow.)
Changelog-friendly one-liner:
Contributor checklist