Merge pull request #2934 from IamAdiSri/master

Added shell deactivation instructions to documentation
pypa · Oct 7, 2018 · aa973c8 · aa973c8
2 parents 00d0a71 + 4588ffe
commit aa973c8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git 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
@@ -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.