classification
Title: Python 3.0 internet documentation needs work
Type: feature request Stage: needs patch
Components: Documentation Versions: Python 3.0
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: beazley, ezio.melotti, georg.brandl, orsenthil (4)
Priority: normal Keywords easy

Created on 2008-12-27 13:14 by beazley, last changed 2009-07-01 10:14 by ezio.melotti.

Messages (3)
msg78361 - (view) Author: David M. Beazley (beazley) Date: 2008-12-27 13:14
I have recently completed a pretty thorough survey of library 
documentation for Python 3.0 in conjunction with an update I'm making to 
my book.   This issue is not so much a bug as a documentation request.

For all of the library modules related to network programming, it would 
be extremely useful to be much very explicit about what methods work 
with strings and what methods requires byte.  So many of these modules 
operate on small fragments of data (e.g., send a request, add a header, 
parse a query string, etc.).  Sometimes using a string is okay, 
sometimes it's not and sadly, it's not often predictable.   Part of the 
problem is that the documentation has been written for a Python 2 world 
where text strings and binary data were interchangeable.

Anyways, this request minimally covers these modules:
 
      ftplib
      smtplib
      nntplib
      http.*
      urllib.*
      xmlrpc.*
      socketserver
      asynchat
      asyncore
    
If there is interest, I can submit more detailed notes from my own work, 
but I'm not sure how the documentation maintainer would want this.  
Separate issue for each?   Added as comments here?   Please advise.
msg78376 - (view) Author: Georg Brandl (georg.brandl) Date: 2008-12-27 18:22
I'd be happy with comments on this bug.  I can't promise that I'll have
the time to review everything, but the more specific the remarks are,
the easier it's for me to update the docs.

Thanks for your efforts!
msg89969 - (view) Author: Ezio Melotti (ezio.melotti) Date: 2009-07-01 10:14
David, I think that a list of notes posted here is ok, can you still
provide them?
History
Date User Action Args
2009-07-01 10:14:42ezio.melottisetnosy: + ezio.melotti
messages: + msg89969
2009-04-22 18:47:54ajaksu2setpriority: normal
keywords: + easy
2009-02-12 18:45:38ajaksu2setnosy: + orsenthil
stage: needs patch
2008-12-27 18:22:23georg.brandlsetmessages: + msg78376
2008-12-27 13:14:39beazleycreate