[Python-Dev] Libref sections to put new modules under?

2006-03-27 Thread 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 (??)

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.

___
Python-Dev mailing list
Python-Dev@python.org
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com


Re: [Python-Dev] Libref sections to put new modules under?

2006-03-27 Thread Guido van Rossum
On 3/27/06, Phillip J. Eby <[EMAIL PROTECTED]> wrote:
> 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/)
___
Python-Dev mailing list
Python-Dev@python.org
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com


Re: [Python-Dev] Libref sections to put new modules under?

2006-03-27 Thread Fred L. Drake, Jr.
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.   
___
Python-Dev mailing list
Python-Dev@python.org
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com


Re: [Python-Dev] Libref sections to put new modules under?

2006-03-27 Thread Phillip J. Eby
At 01:33 PM 3/27/2006 -0800, Guido van Rossum wrote:
>Is the with statement documented yet?

Sort of.  I've added stuff to the language reference, but the "What's New" 
for it is blank right now.  There's nothing in the tutorial, either, and of 
course contextlib isn't in the libref yet (which is what triggered my 
question).

PEP 342 is also virtually undocumented outside of the "What's New".  So far 
all I've done is correct the part about yield not being allowed in 
try/finally; apart from that I'm a bit hung up on how to document the new 
hybrid nature of "yield" in the language reference.  It's like "New 
YIELD!  It's a statement!  It's an expression!  It's an 
operator!  It's...  well, we don't know what it is.  But it's great!"  :)

Suggestions on how to handle this appreciated.  :)

___
Python-Dev mailing list
Python-Dev@python.org
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com


Re: [Python-Dev] Libref sections to put new modules under?

2006-03-27 Thread Thomas Heller
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.html 
.


Thomas

___
Python-Dev mailing list
Python-Dev@python.org
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com


Re: [Python-Dev] Libref sections to put new modules under?

2006-03-28 Thread Nick Coghlan
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   |   [EMAIL PROTECTED]   |   Brisbane, Australia
---
 http://www.boredomandlaziness.org
___
Python-Dev mailing list
Python-Dev@python.org
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com