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

Clarify pipenv install documentation #2844

Merged
merged 4 commits into from
Sep 14, 2018
Merged

Clarify pipenv install documentation #2844

merged 4 commits into from
Sep 14, 2018

Conversation

g4b1nagy
Copy link

if no packages are given sounds a bit better than
if none is given when referring to provided packages.

Also mention that pipenv install with no provided packages
installs all packages from Pipfile. It is not obvious for
people new to pipenv whether pipenv is using Pipfile or
Pipfile.lock by default.

`if no packages are given` sounds a bit better than
`if none is given` when referring to `provided packages`.

Also mention that `pipenv install` with no provided packages
installs all packages from Pipfile. It is not obvious for
people new to pipenv whether pipenv is using Pipfile or
Pipfile.lock by default.
@g4b1nagy
Copy link
Author

PS: thank you for all the hard work you've shared with us!
These are just a few minor changes that I think will make documentation a bit more clear. Please let me know if you'd like me to make any changes.

@uranusjr
Copy link
Member

Looks reasonable to me. Would you mind adding a fragment to the news directory to describe this change? It would appear in the changelog.

@g4b1nagy
Copy link
Author

Sure thing! I've added a commit with the news fragment. Please let me know what you think.

By default, `pipenv install` will install packages
based on the list in `Pipfile`, not `Pipfile.lock`.
`pipenv install --dev` is no exception.

I've tested this using pipenv 2018.7.1
with different package versions in `Pipfile`
and `Pipfile.lock`. After `pipenv install`,
the versions in `Pipfile` were the ones
actually installed.
@g4b1nagy
Copy link
Author

@uranusjr I've found another small issue in the documentation, so I've added a new commit. Please let me know what you think.

The previous help text made it seem that
`pipenv install --dev` would install ONLY
dev-packages, which is not the case.

The current description is identical to the
one used in the documentation, which is
a lot clearer.
@uranusjr uranusjr merged commit 9105ac4 into pypa:master Sep 14, 2018
@g4b1nagy
Copy link
Author

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants