realpython / realpython/python-guide

Clarification on pipenv and virtualenv

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

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

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

説明

In the Virtual Environments document (dev/virtualenvs/) we start off by learning about pipenv but then move on to the lower level virtualenv. It is a little unclear under what circumstances we would be using virtualenv? I mean, I know it can practically be used, but for folks approaching Python for the first time it can be confusing.

I'm not suggesting the virtualenv section should go away, but maybe some additional clarification would be helpful. Something along the lines of:

"pipenv wraps a lower-level virtual environment utility - virtualenv. If you want to learn about using virtualenv, read on. Otherwise you can skip to the next chapter."

Where I personally really started getting confused is under Other Notes. Without scrolling back up the page it is not clear if this section is a part of the virtualenv discussion or if it is meant to be top-level and thus applicable to both pipenv and virtualenv.

Things become murkier when we start throwing additional utilities into the mix - as someone without experience with these utilities it seems to me that together they run somewhat parallel to pipenv.

Thanks for your hard work on this guide!

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

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

はじめの一歩

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

調査の方向性

dev/virtualenvs/ にある Virtual Environments ドキュメントから始め、pipenv、virtualenv、Other Notes の各セクションをまとめて読みます。pipenv と virtualenv の関係を明確にし、読者が virtualenv に関する内容をいつ省略できるかを示し、どのノートが各ユーティリティに適用されるのかを明確にします。Python を初めて読む読者が混乱せずにセクションを読み進められれば完了です。

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

評価

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

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

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