From 4588ffebda2cb6ee28c8c7699dc20fc038d411a6 Mon Sep 17 00:00:00 2001 From: Aditya Srivastava Date: Sun, 7 Oct 2018 07:18:53 +0530 Subject: [PATCH] Added shell deactivation instruction to documentation Minor edits to documentation --- docs/basics.rst | 4 ++-- docs/index.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/basics.rst b/docs/basics.rst index 5d41249f..709f0b08 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -135,7 +135,6 @@ Example Pipfile.lock Clone / create project repository:: - … $ cd myproject Install from Pipfile, if there is one:: @@ -152,7 +151,8 @@ Next, activate the Pipenv shell:: $ pipenv shell $ python --version - … + +This will spawn a new shell subprocess, which can be deactivated by using ``exit``. .. _initialization: diff --git a/docs/index.rst b/docs/index.rst index 957d6c8c..c712464e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -102,7 +102,7 @@ Other Commands ////////////// - ``graph`` will show you a dependency graph of your installed dependencies. -- ``shell`` will spawn a shell with the virtualenv activated. +- ``shell`` will spawn a shell with the virtualenv activated. This shell can be deactivated by using ``exit``. - ``run`` will run a given command from the virtualenv, with any arguments forwarded (e.g. ``$ pipenv run python`` or ``$ pipenv run pip freeze``). - ``check`` checks for security vulnerabilities and asserts that PEP 508 requirements are being met by the current environment.