Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pip-tools should be installed in the project's virtual environment #1023

Merged
merged 2 commits into from
Jan 30, 2020
Merged

pip-tools should be installed in the project's virtual environment #1023

merged 2 commits into from
Jan 30, 2020

Conversation

tekumara
Copy link
Contributor

@tekumara tekumara commented Dec 25, 2019

Fix #1021

Changelog-friendly one-liner: Make the readme more imperative about installing into a project's virtual environment to avoid confusion

Contributor checklist
  • Provided the tests for the changes.
  • Gave a clear one-line description in the PR (that the maintainers can add to CHANGELOG.md on release).
  • Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

@atugushev atugushev added the docs Documentation related label Dec 25, 2019
@codecov
Copy link

codecov bot commented Dec 25, 2019

Codecov Report

Merging #1023 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1023   +/-   ##
=======================================
  Coverage   99.11%   99.11%           
=======================================
  Files          34       34           
  Lines        2364     2364           
  Branches      303      303           
=======================================
  Hits         2343     2343           
  Misses         11       11           
  Partials       10       10

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0da08e5...fefeb33. Read the comment docs.

@atugushev atugushev changed the title docs - pip-tools should be installed in the project's virtual environment pip-tools should be installed in the project's virtual environment Dec 28, 2019
Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution! Generally looks good to me. One thing which bothers me, maybe the details should be explained in its own sections for pip-compile and pip-sync?

@tekumara
Copy link
Contributor Author

@atugushev I've moved the details into the suggested sections, how does it look now?

Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update! I'll approve this, but I'd like to hear an opinion from someone else since I'm not a native English speaker.

@atugushev atugushev added this to the 4.4.1 milestone Jan 30, 2020
@atugushev atugushev merged commit 604071d into jazzband:master Jan 30, 2020
@atugushev
Copy link
Member

@tekumara, thanks for your first-time contribution and welcome to the pip-tools contributors 😊 Nicely done!

@tekumara tekumara deleted the improve-install-docs branch February 1, 2020 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pip-sync does not upgrade existing packages
2 participants