Replace ~ with $HOME in guides, tutorials
#418
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Be more explicit to help users who aren't as familiar with the tilde.
theacodes
approved these changes
Dec 13, 2017
|
Thanks, @brainwane! |
pradyunsg
reviewed
Dec 15, 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) | |||
There was a problem hiding this comment.
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Be more explicit to help users who aren't as familiar with the tilde. Inspired by an experience @lgh2 had, figuring out where
.pypircfiles live:<lghampton>I think it was the~/.pypircsyntax that confused me, it wasn't clear to me that it referred to$HOMEor something relative to the project pathI 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 insource/tutorials/managing-dependencies.rst:cc @jonparrott