This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author ncoghlan
Recipients docs@python, eric.araujo, ncoghlan
Date 2012-05-29.03:33:48
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1338262430.02.0.211807154794.issue14945@psf.upfronthosting.co.za>
In-reply-to
Content
I think for these it's reasonable to just have an index page that references out to the individual module docs. Most of them are closely related to using the module in your own code and/or there's general background info in the module docs that you're likely to need in order to understand what the tool is for.

The main thing I'm after at this point is for Setup & Usage to act as a central index for using Python from the command line, rather than it necessarily containing all the details directly. Rather than trying too hard to categorise them, I'd be inclined to start with a simple alphabetical list (module name linking to the relevant section in the module docs, adding it if it doesn't already exist). Something like:

compileall - Precompiling Python source modules to bytecode
pickle - Display the contents of pickles saved as files
pickletools - Analyse the contents of pickles saved as files
site - Display details of Python's configuration
sysconfig - Display additional details of Python's configuration
test - Execute Python's own regression test suite
timeit - Microbenchmarking for small Python snippets
unittest - Find and execute unit tests

Maybe we'll decide to do something more long term, but I think this is a good way to start.
History
Date User Action Args
2012-05-29 03:33:50ncoghlansetrecipients: + ncoghlan, eric.araujo, docs@python
2012-05-29 03:33:50ncoghlansetmessageid: <1338262430.02.0.211807154794.issue14945@psf.upfronthosting.co.za>
2012-05-29 03:33:49ncoghlanlinkissue14945 messages
2012-05-29 03:33:48ncoghlancreate