realpython / realpython/python-guide

Inconsistency in python2 installation instructions

Open
#1,015 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Batchfile
Stars
29.8k
Forks
5.9k
PR merge metrics
No merged PRs in 30d

Description

It says that python gets left to point to the system python (2.7 on OSX), but then goes on to say that python points to homebrew Python3.

https://github.com/realpython/python-guide/blame/master/docs/starting/install/osx.rst#L84-L89

Not sure which bit needs to be changed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading docs/starting/install/osx.rst around lines 84-89, as linked in the issue. Determine which statement accurately describes the Python 2 installation behavior, then update the contradictory wording so the instructions are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.