classification
Title: distutils Command docs linking
Type: Stage: needs patch
Components: Documentation Versions: Python 3.1, Python 3.2, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: alexis, docs@python, eric.araujo, georg.brandl, python-dev, tarek, techtonik
Priority: normal Keywords:

Created on 2010-07-11 09:55 by techtonik, last changed 2011-05-29 16:00 by python-dev. This issue is now closed.

Messages (5)
msg109979 - (view) Author: anatoly techtonik (techtonik) Date: 2010-07-11 09:55
There are a couple of chapters about implementing a command in distutils docs that should be linked together.

http://docs.python.org/distutils/extending.html#extending-distutils should link to http://docs.python.org/distutils/apiref.html#distutils.cmd.Command and the latter to http://docs.python.org/distutils/apiref.html#creating-a-new-distutils-command (or merged).
msg109983 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-07-11 10:18
Note for someone wanting to propose a patch: distutils is in the process of being improved and cleaned up as distutils2. Improving the documentation is part of the process. Adding cross-links in the existing docs is okay, but I’d recommend against using too much time for distutils. For example, merging sections or doing other significant work would be IMO (which is only one opinion) time better spent on something else.
msg109986 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-07-11 10:26
Thanks, should be fixed in r82806.
msg109995 - (view) Author: anatoly techtonik (techtonik) Date: 2010-07-11 11:36
Eric, think about people who will be porting old code from distutils. They need to understand the behavior of distutils even if you'd like to force them to rewrite the logic for distutils2 from scratch.
msg137189 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-05-29 16:00
New changeset db60dee0019b by Éric Araujo in branch '2.7':
Backport doc improvements for distutils.cmd.Command (#9223).
http://hg.python.org/cpython/rev/db60dee0019b
History
Date User Action Args
2011-05-29 16:00:14python-devsetnosy: + python-dev
messages: + msg137189
2010-07-11 11:36:44techtoniksetmessages: + msg109995
2010-07-11 10:26:22georg.brandlsetstatus: open -> closed

nosy: + georg.brandl
messages: + msg109986

resolution: fixed
2010-07-11 10:18:39eric.araujosetassignee: tarek -> docs@python
components: - Distutils
versions: + Python 3.1
nosy: + alexis, eric.araujo

messages: + msg109983
stage: needs patch
2010-07-11 09:55:41techtoniksetnosy: + docs@python
2010-07-11 09:55:30techtoniksetnosy: techtonik, tarek
components: + Documentation
versions: + Python 2.7, Python 3.2
2010-07-11 09:55:17techtonikcreate