Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

distutils Command docs linking #53469

Closed
techtonik mannequin opened this issue Jul 11, 2010 · 5 comments
Closed

distutils Command docs linking #53469

techtonik mannequin opened this issue Jul 11, 2010 · 5 comments
Labels
docs Documentation in the Doc dir

Comments

@techtonik
Copy link
Mannequin

techtonik mannequin commented Jul 11, 2010

BPO 9223
Nosy @birkenfeld, @tarekziade, @merwok

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2010-07-11.10:26:22.279>
created_at = <Date 2010-07-11.09:55:17.812>
labels = ['docs']
title = 'distutils Command docs linking'
updated_at = <Date 2011-05-29.16:00:14.654>
user = 'https://bugs.python.org/techtonik'

bugs.python.org fields:

activity = <Date 2011-05-29.16:00:14.654>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2010-07-11.10:26:22.279>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2010-07-11.09:55:17.812>
creator = 'techtonik'
dependencies = []
files = []
hgrepos = []
issue_num = 9223
keywords = []
message_count = 5.0
messages = ['109979', '109983', '109986', '109995', '137189']
nosy_count = 7.0
nosy_names = ['georg.brandl', 'techtonik', 'tarek', 'eric.araujo', 'docs@python', 'alexis', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'needs patch'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue9223'
versions = ['Python 3.1', 'Python 2.7', 'Python 3.2']
@techtonik
Copy link
Mannequin Author

techtonik mannequin commented Jul 11, 2010

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).

@techtonik techtonik mannequin assigned tarekziade Jul 11, 2010
@techtonik techtonik mannequin added stdlib Python modules in the Lib dir docs Documentation in the Doc dir labels Jul 11, 2010
@merwok
Copy link
Member

merwok commented Jul 11, 2010

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.

@merwok merwok removed the stdlib Python modules in the Lib dir label Jul 11, 2010
@merwok merwok assigned docspython and unassigned tarekziade Jul 11, 2010
@birkenfeld
Copy link
Member

Thanks, should be fixed in r82806.

@techtonik
Copy link
Mannequin Author

techtonik mannequin commented Jul 11, 2010

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.

@python-dev
Copy link
Mannequin

python-dev mannequin commented May 29, 2011

New changeset db60dee0019b by Éric Araujo in branch '2.7':
Backport doc improvements for distutils.cmd.Command (bpo-9223).
http://hg.python.org/cpython/rev/db60dee0019b

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@birkenfeld @merwok