-
Notifications
You must be signed in to change notification settings - Fork 928
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
Fix executable dir in + tabify pip & virtual envs guide #928
Fix executable dir in + tabify pip & virtual envs guide #928
Conversation
source/guides/installing-using-pip-and-virtual-environments.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this; I like seeing the adoption of tabs in this doc. I've got a few questions/suggestions.
|
||
Afterwards, you should have the newest pip installed in your user site: | ||
py -m pip --version | ||
pip 9.0.1 from c:\python36\lib\site-packages (Python 3.6.1) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a very old version of pip and Python. Can we take the opportunity to show the latest version for Windows and Unix/macOS?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, this is one of a few places in this document where the command and its output are shown in a single code-block
, but with no distinction between them, which might lead folks to thinking that pip 9.0.1 ...
is a command to execute.
If the output is valuable, I recommend putting into a separate code-block
, maybe something like:
pip 9.0.1 from c:\python36\lib\site-packages (Python 3.6.1) | |
.. code-block:: text | |
pip 9.0.1 from c:\python36\lib\site-packages (Python 3.6.1) |
Again, we'd want to do the same for Unix/macOS, and similarly for the "You can confirm you're in the virtual environment" instructions. But that could also be a follow-up PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was avoiding any informational changes to the document since I was afraid I lack the domain knowledge to do them properly, but this seems reasonable and I like it! I think it's fine to include these changes (on a first glance) since this PR already makes significant visual changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, I think the fact this PR makes significant visual changes is reason enough to do this in a subsequent PR. Let's just fix the slashes (below) for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've created #931 as a follow-up.
source/guides/installing-using-pip-and-virtual-environments.rst
Outdated
Show resolved
Hide resolved
Windows actually uses backslashes, not regular ol' slashes, oops :) Co-authored-by: Brian Rutledge <brian@bhrutledge.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
I think you can use the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One more small tweak, based on @henryiii's observation.
source/guides/installing-using-pip-and-virtual-environments.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Brian Rutledge <brian@bhrutledge.com>
Thanks @henryiii, @pradyunsg and @bhrutledge for the reviews, it's well appreciated! 🙂 |
Fixes #783.
This patch also completes the "tabification" this document.