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

Update basics.rst with `$SHELL`. #2671

Merged
merged 9 commits into from Aug 10, 2018

Conversation

Projects
None yet
3 participants
@HopeForToday
Contributor

HopeForToday commented Jul 29, 2018

State the role of $SHELL in pipenv shell command.

HopeForToday added some commits Jul 29, 2018

Update basics.rst with `$SHELL`
State the role of `$SHELL` in `pipenv shell` command.
Merge pull request #1 from HopeForToday/improve-docs
Update basics.rst with `$SHELL`.
@uranusjr

This comment has been minimized.

Member

uranusjr commented Jul 30, 2018

Hi, the shell detection went through a couple of changes in recent versions. The current logic works like this:

  1. Check if PIPENV_SHELL is set—use it if available.
  2. Detect the current shell automatically.
  3. If the detection fails, use SHELL or PYENV_SHELL.
  4. If either of the above two is set, use COMSPEC (added in master, will be in the next version).
  5. Give up

So setting SHELL is less useful in the current version. We encourage users to try to rely on auto shell detection, and set PIPENV_SHELL if that fails. Could you expand the section to reflect this behaviour better, so it can be more useful to more people? A link to the environment variable section would also be awesome.

Thanks for the work! Documentation contribution is the best ❤️❤️❤️❤️

@HopeForToday

This comment has been minimized.

Contributor

HopeForToday commented Jul 31, 2018

Ok, I'll try it, as my English is poor. My draft may need your correction.

@HopeForToday

This comment has been minimized.

Contributor

HopeForToday commented Jul 31, 2018

The 4th point, may be neither rather than either? As I googled COMSPEC, it's one of the environment variables used in DOS, OS/2 and Windows.

@uranusjr

This comment has been minimized.

Member

uranusjr commented Jul 31, 2018

Ah yes, sorry, typo :)

Update basics.rst
Add the description of `PIPENV_SHELL`
@HopeForToday

This comment has been minimized.

Contributor

HopeForToday commented Aug 2, 2018

I just updated it, can you check it?

@uranusjr

This comment has been minimized.

Member

uranusjr commented Aug 2, 2018

Hi, this looks good! Only one thing—can you switch the link to use Sphinx’s reference syntax instead?

Update basics.rst
Update link with Sphinx’s reference syntax.
@HopeForToday

This comment has been minimized.

Contributor

HopeForToday commented Aug 2, 2018

En, I updated it again.

@@ -326,6 +326,7 @@ You should do this for your shell too, in your ``~/.profile`` or ``~/.bashrc`` o
.. note:: The shell launched in interactive mode. This means that if your shell reads its configuration from a specific file for interactive mode (e.g. bash by default looks for a ``~/.bashrc`` configuration file for interactive mode), then you'll need to modify (or create) this file.
If you get something wrong with ``$ pipenv shell``, just check ``PIPENV_SHELL`` environment variable, ``$ pipenv shell`` will use it if available. For detail, see :ref:`configuration-with-environment-variables`.

This comment has been minimized.

@techalchemy

techalchemy Aug 4, 2018

Member

If you get something wrong with

Can you change this to 'If you experience issues with`? Minor change but I think it's a tiny bit more natural.

just check PIPENV_SHELL environment variable

just check PIPENV_SHELL environment variable, $ pipenv shell just check the PIPENV_SHELL environment variable, which $ pipenv shell will use if available.

Minor tense changes mainly, thanks for contributing this!

This comment has been minimized.

@HopeForToday

HopeForToday Aug 7, 2018

Contributor

Updated.

HopeForToday added some commits Aug 7, 2018

@HopeForToday

This comment has been minimized.

Contributor

HopeForToday commented Aug 8, 2018

Just updated.

techalchemy added a commit that referenced this pull request Aug 10, 2018

@techalchemy techalchemy removed the needs news label Aug 10, 2018

@techalchemy techalchemy merged commit c79507b into pypa:master Aug 10, 2018

1 check was pending

buildkite/pipenv Build #1148 scheduled
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment