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

Replace `~` with `$HOME` in guides, tutorials #418

Merged
merged 2 commits into from Dec 13, 2017

Conversation

Projects
None yet
3 participants
@brainwane
Member

brainwane commented Dec 13, 2017

Be more explicit to help users who aren't as familiar with the tilde. Inspired by an experience @lgh2 had, figuring out where .pypirc files live:

<lghampton> I think it was the ~/.pypirc syntax that confused me, it wasn't clear to me that it referred to $HOME or something relative to the project path

I left out instances where the tilde was explicitly explained in the paragraph where it was used (source/tutorials/managing-dependencies.rst, and where the tilde appeared as part of sample terminal output).

I might be wrong in proposing this PR. I'm open to being told, for instance, that we need to use ~ for platform compatibility reasons, or for uniformity with other documentation. In that case I'd like for us to explicitly mention what it means, contextually, as in source/tutorials/managing-dependencies.rst:

this will typically print ~/.local (with ~ expanded to the absolute path to your home directory)

cc @jonparrott

brainwane added some commits Dec 13, 2017

Replace `~` with `$HOME` in guides, tutorials
Be more explicit to help users who aren't as familiar
with the tilde.

@theacodes theacodes merged commit 947abe0 into pypa:master Dec 13, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@theacodes

This comment has been minimized.

Member

theacodes commented Dec 13, 2017

Thanks, @brainwane!

@brainwane brainwane deleted the brainwane:home-versus-tilde branch Dec 13, 2017

@@ -55,7 +55,7 @@ Afterwards, you should have the newest pip installed in your user site:
.. code-block:: bash
python3 -m pip --version
pip 9.0.1 from ~/.local/lib/python3.6/site-packages (python 3.6)
pip 9.0.1 from $HOME/.local/lib/python3.6/site-packages (python 3.6)

This comment has been minimized.

@pradyunsg

pradyunsg Dec 15, 2017

Member

Isn't this output?

This comment has been minimized.

@theacodes

theacodes Dec 15, 2017

Member

Yeah but in both cases it's representative as pip actually outputs the whole path, e.g.:

pip 9.0.1 from /Users/jonwayne/.pyenv/versions/2.7.13/lib/python2.7/site-packages (python 2.7)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment