classification
Title: Usage documentation for pyvenv
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.3
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, ncoghlan, tshepang, vinay.sajip
Priority: deferred blocker Keywords:

Created on 2012-05-28 23:10 by ncoghlan, last changed 2012-05-29 11:55 by vinay.sajip. This issue is now closed.

Messages (5)
msg161815 - (view) Author: Nick Coghlan (ncoghlan) * (Python committer) Date: 2012-05-28 23:10
Command line documentation for pyvenv must be provided under http://docs.python.org/dev/using/index.html before 3.3 is released.
msg161824 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-05-29 00:34
I would document it in library/venv, just like other tools are documented in the relevant module docs.  I’m nonetheless +1 to listing all scripts installed by Python in the Setup and Usage docs, with links.
msg161827 - (view) Author: Nick Coghlan (ncoghlan) * (Python committer) Date: 2012-05-29 01:43
No, we need to start using the Setup & Usage docs *more*, not less.

All tools with useful command line behaviour (especially those that are directly installed as scripts) should eventually be documented here.

The fact this has historically been avoided is no excuse for perpetuating the mistake.
msg161862 - (view) Author: Vinay Sajip (vinay.sajip) * (Python committer) Date: 2012-05-29 09:11
The "Using" section has 4 sub-sections: one on the Python command line, + 3 on Python usage on Windows, Linux and OS X.

I propose to add a fourth sub-section "Additional Tools and Scripts" (feel free to suggest an alternative title) and under that, add a section for pyvenv.
msg161871 - (view) Author: Vinay Sajip (vinay.sajip) * (Python committer) Date: 2012-05-29 11:55
Done in ace7c340d95d.
History
Date User Action Args
2012-05-29 11:55:56vinay.sajipsetstatus: open -> closed
resolution: fixed
messages: + msg161871

stage: needs patch -> resolved
2012-05-29 09:11:34vinay.sajipsetmessages: + msg161862
2012-05-29 03:57:56tshepangsetnosy: + tshepang
2012-05-29 01:43:11ncoghlansetmessages: + msg161827
2012-05-29 00:34:42eric.araujosetnosy: + eric.araujo
messages: + msg161824
2012-05-28 23:10:03ncoghlancreate