Potential for confusion on Pipenv & Virtual Environments
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by comparing the Installing Python 3 on Mac OS X and Pipenv & Virtual Environments pages, especially their instructions for checking the Python version. Clarify which command should be used for Python 3 and explain the differing python, python2, and python3 commands; the documentation is done when the setup guidance is unambiguous for the described macOS environment.
Written by the indexing model from the issue text.
Description
I arrived on the Pipenv & Virtual Environments page from Installing Python 3 on Mac OS X. At that point, I've have installed python2 and python3 via homebrew and there is also the system python. Installing Python 3 on Mac OS X clearly states that
Working with Python 3
At this point, you have the system Python 2.7 available, potentially the Homebrew version of Python 2 installed, and the Homebrew version of Python 3 as well.
$ python
will launch the system Python interpreter.
$ python2
will launch the homebrew-installed Python 2 interpreter (if any).
$ python3
will launch the homebrew-installed Python 3 interpreter.
And yet on Pipenv & Virtual Environments the first thing I'm encouraged to do is make sure python3 is installed by typing $python --version which will display the system Python interpreter version.
This could potentially confuse a new developer who may be wondering why they are seeing version say 2.7.x instead of 3.6.x as the writeup suggest. Besides as at the time of writting there are not many OS's that have $python defaulting to version 3.6.x.
If the writeup in insisting of starting Python 3 with the command $python then it needs to be explained how this can be done safely.
Thanks.
- Dominant language
- Batchfile
- Stars
- 29.8k
- Forks
- 5.9k
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from realpython/python-guide
-
Page 404 error Open
Difficulty 1/5 Under an hour Newbie friendliness 65/100
realpython/python-guide#1104 · 2 comments ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 62/100
realpython/python-guide#327 ·
-
PyZMQ improvements Open
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
realpython/python-guide#326 · 5 comments ·
-
@alex Open
Difficulty 5/5 Over a week Newbie friendliness 10/100
realpython/python-guide#1194 ·
-
Development Team SAP Open
Difficulty 5/5 Over a week Newbie friendliness 10/100
realpython/python-guide#1192 ·
All issues in realpython/python-guide
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
A11y ♿️
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Link Checker Report Openautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
documentation improve or update documentation priority/low triage
Difficulty 2/5 Half a day Newbie friendliness 86/100
warpdotdev/docs#782 · 1 comment ·