diff --git a/README.md b/README.md index 9e23f148c8..f6af5917b2 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/basics.rst b/docs/basics.rst index 559f75709b..5d41249f36 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -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``. diff --git a/news/2844.doc b/news/2844.doc new file mode 100644 index 0000000000..28f2651404 --- /dev/null +++ b/news/2844.doc @@ -0,0 +1 @@ +Clarify `pipenv install` documentation diff --git a/pipenv/cli/command.py b/pipenv/cli/command.py index f6c0d13385..b552778f7e 100644 --- a/pipenv/cli/command.py +++ b/pipenv/cli/command.py @@ -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 @@ -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( diff --git a/pipenv/cli/options.py b/pipenv/cli/options.py index cf9daa190d..99fc5344bf 100644 --- a/pipenv/cli/options.py +++ b/pipenv/cli/options.py @@ -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)