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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,8 @@ Fish is the best shell. You should use it.
provided in Pipfile.
clean Uninstalls all packages not specified in Pipfile.lock.
graph Displays currently–installed dependency graph information.
install Installs provided packages and adds them to Pipfile, or (if none
is given), installs all packages.
install Installs provided packages and adds them to Pipfile, or (if no
packages are given), installs all packages from Pipfile.
lock Generates Pipfile.lock.
open View a given module in your editor.
run Spawns a command installed into the virtualenv.
Expand Down
2 changes: 1 addition & 1 deletion docs/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ The user can provide these additional parameters:
folder is encoded into a "slug value" and appended to ensure the virtualenv name
is unique.

- ``--dev`` — Install both ``develop`` and ``default`` packages from ``Pipfile.lock``.
- ``--dev`` — Install both ``develop`` and ``default`` packages from ``Pipfile``.
- ``--system`` — Use the system ``pip`` command rather than the one from your virtualenv.
- ``--ignore-pipfile`` — Ignore the ``Pipfile`` and install from the ``Pipfile.lock``.
- ``--skip-lock`` — Ignore the ``Pipfile.lock`` and install from the ``Pipfile``. In addition, do not write out a ``Pipfile.lock`` reflecting changes to the ``Pipfile``.
Expand Down
1 change: 1 addition & 0 deletions news/2844.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify `pipenv install` documentation
4 changes: 2 additions & 2 deletions pipenv/cli/command.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ def cli(


@cli.command(
short_help="Installs provided packages and adds them to Pipfile, or (if none is given), installs all packages.",
short_help="Installs provided packages and adds them to Pipfile, or (if no packages are given), installs all packages from Pipfile.",
context_settings=dict(ignore_unknown_options=True, allow_extra_args=True),
)
@system_option
Expand All @@ -224,7 +224,7 @@ def install(
state,
**kwargs
):
"""Installs provided packages and adds them to Pipfile, or (if none is given), installs all packages."""
"""Installs provided packages and adds them to Pipfile, or (if no packages are given), installs all packages from Pipfile."""
from ..core import do_install

retcode = do_install(
Expand Down
2 changes: 1 addition & 1 deletion pipenv/cli/options.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ def callback(ctx, param, value):
state.installstate.dev = value
return value
return option("--dev", "-d", is_flag=True, default=False, type=click_booltype,
help="Install package(s) in [dev-packages].", callback=callback,
help="Install both develop and default packages.", callback=callback,
expose_value=False)(f)


Expand Down