Libref sections to put new modules under?
Any thoughts on where documentation for the new "contextlib" module should go in the library reference? Some candidates: * Program Frameworks (???) * Development Tools (??) * Python Runtime Services (?) * Python Language Services (??) * Miscellaneous Services (??) A similar issue exists for "ctypes" module, although I imagine an argument could easily be made for putting it with "Optional Operating System Services". wsgiref can probably go in "Internet Protocols and Support", while ElementTree obviously goes under "Structured Markup Processing Tools". What other new modules do we have going in 2.5 that haven't found a home in the documentation yet? I seem to recall some discussion about a decorator library or functools or something of that sort.
On 3/27/06, Phillip J. Eby
Any thoughts on where documentation for the new "contextlib" module should go in the library reference?
Some candidates:
* Program Frameworks (???) * Development Tools (??) * Python Runtime Services (?) * Python Language Services (??) * Miscellaneous Services (??)
Runtime Services is by far the best candidate. The Language services are more for code that reads/writes Python source code or bytecode. The others are even less likely matches. (What's development tools?)
A similar issue exists for "ctypes" module, although I imagine an argument could easily be made for putting it with "Optional Operating System Services".
+1
wsgiref can probably go in "Internet Protocols and Support", while ElementTree obviously goes under "Structured Markup Processing Tools".
+1
What other new modules do we have going in 2.5 that haven't found a home in the documentation yet? I seem to recall some discussion about a decorator library or functools or something of that sort.
Is the with statement documented yet? -- --Guido van Rossum (home page: http://www.python.org/~guido/)
On Monday 27 March 2006 16:26, Phillip J. Eby wrote:
Any thoughts on where documentation for the new "contextlib" module should go in the library reference?
Most definately in "Python Runtime Services."
A similar issue exists for "ctypes" module, although I imagine an argument could easily be made for putting it with "Optional Operating System Services".
I'm less sure of that one. It could reasonably go in "Python Runtime Services," "Generic Operating System Services," or "Optional Operating System Services."
wsgiref can probably go in "Internet Protocols and Support", while ElementTree obviously goes under "Structured Markup Processing Tools".
Yes to both. -Fred -- Fred L. Drake, Jr. <fdrake at acm.org>
Fred L. Drake, Jr. wrote:
On Monday 27 March 2006 16:26, Phillip J. Eby wrote:
Any thoughts on where documentation for the new "contextlib" module should go in the library reference?
Most definately in "Python Runtime Services."
A similar issue exists for "ctypes" module, although I imagine an argument could easily be made for putting it with "Optional Operating System Services".
I'm less sure of that one. It could reasonably go in "Python Runtime Services," "Generic Operating System Services," or "Optional Operating System Services."
I had the same thought as Philip. For a preview of what it could look like, see http://starship.python.net/crew/theller/python-docs/html/lib/ , especially http://starship.python.net/crew/theller/python-docs/html/lib/module-ctypes.h... . Thomas
Phillip J. Eby wrote:
What other new modules do we have going in 2.5 that haven't found a home in the documentation yet? I seem to recall some discussion about a decorator library or functools or something of that sort.
The suggestion with functools was to rename functional.partial to functools.partial, and add a functools.decorator function. The idea of the latter being that sticking @decorator on the front would be enough to make a decorator function well-behaved (and future-proof). Cheers, Nick. -- Nick Coghlan | ncoghlan@gmail.com | Brisbane, Australia --------------------------------------------------------------- http://www.boredomandlaziness.org
participants (5)
-
Fred L. Drake, Jr. -
Guido van Rossum -
Nick Coghlan -
Phillip J. Eby -
Thomas Heller