realpython / realpython/python-guide

Potential for confusion on Pipenv & Virtual Environments

オープン
#840 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Batchfile
スター
29.8k
フォーク
5.9k
PR マージ指標
30日以内にマージされた PR はありません

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、Installing Python 3 on Mac OS XPipenv & Virtual Environments のページを比較し、特に Python のバージョン確認に関する手順を確認します。Python 3 にはどのコマンドを使用すべきかを明確にし、pythonpython2python3 の各コマンドの違いを説明してください。説明されている macOS 環境についてセットアップ手順が明確になれば、ドキュメントは完成です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。