Mailman 3 August 2000 - Doc-SIG

Nit in "urllib" library documentation
by Ka-Ping Yee Oct. 10, 2000

Oct. 10, 2000

See http://www.python.org/doc/1.5.2p2/lib/module-urllib.html The last chunk of the section on "urlopen" appears to be repeated twice: The urlopen() function works transparently with proxies... For example (the "%" is the command prompt): ... In a Macintosh environment, urlopen() will retrieve proxy information from Internet Config. The urlopen() function works transparently with proxies... For example (the "%" is the command prompt): ... In a Macintosh environment, urlopen() will retrieve proxy information from Internet Config. -- ?!ng

2 1

library reference contents
by Ka-Ping Yee Oct. 10, 2000

Oct. 10, 2000

The contents page of the Library Reference has a few warts: - A few section headers (e.g. operator, pprint, repr) end in periods that probably ought to be deleted. (Complete list: 3.5, 3.23, 3.24, 3.27, 3.32, 4.2, 4.3, 4.5, 5.10, 6.13, 6.15, 7.1, 7.6, 11.11, 11.12, 11.13, 12.13, 12.14, 14.9, 14.10, 15.4.) - Description of 3.28 "new" doesn't make much sense: "runtime implementation object creation" (probably you want to replace "implementation" with "instance") - Description of 4.3 "regex" should probably say "old" or "deprecated". - Description of 6.12 "curses" has a spelling mistake: "Terminal independant (sic) console handling". - Description of 7.14 "rlcompleter" probably ought to say "Completion function for GNU readline". - Descriptions of 11.14 "SimpleHTTPServer" and 11.15 "CGIHTTPServer" seem strange: "A Do-Something Request Handler". Suggest "11.14 SimpleHTTPServer -- A simple HTTP request handler" and "11.16 CGIHTTPServer -- A CGI-capable HTTP request handler". Hope this helps. -- ?!ng "I'm not trying not to answer the question; i'm just not answering it." -- Lenore Snell

2 1

Docs for methods of string and unicode objects
by Denis S. Otkidach Aug. 21, 2000

Aug. 21, 2000

Dear Fred, I have noticed that interface of translate method applied to unicode object differs from interface of the same method applied to string object. In the former case translation table should be an object with mapping interface (not a string), and characters to be deleted are denoted by None value in translation table (not a separate string argument). Hmm... That's why translate method doesn't work for UserString instances reffering to unicode object. The methods encode, isdecimal, and isnumeric are applicable only to unicode objects. The later two methods are not mentioned in documentation. With best regards, Denis.

2 1

Documenting "Magic" Methods
by Moshe Zadka Aug. 18, 2000

Aug. 18, 2000

I assumed that the Python documentation has a standard way to document classes which define magic methods. However, on looking through the documented modules, I saw that it was elegently (and sometimes not so elegantly) avoided -- "dictionary-like interface" is the only thing (apart from examples) that can be found about shelve.shelve.__[get|set|del]item__. Is there something I missed, or is this area really untouched? -- Moshe Zadka <moshez(a)math.huji.ac.il> There is no IGLU cabal. http://advogato.org/person/moshez

4 9

Status of extracting docstrings
by Mike Miller Aug. 11, 2000

Aug. 11, 2000

I'm in the process of starting up a fairly significant programming project using Python (first time on Python). And embedded documentation like the docstrings (or javadoc/POD/Cocoon) is going to be very important to this particular project. I've taken a look at pythondoc and it still seems a bit limited in scope. Is there some other mechanism(s) or something in version 1.6 that I'm missing? Currently it's looking like I'm going to need to extend pythondoc or write something from scratch. Thanks, - Mike Miller mikem(a)ichips.intel.com

2 1

Doc-SIG -- confirmation of subscription -- request 976111
by Matthew Haynes Aug. 9, 2000

Aug. 9, 2000

confirm 976111

1 0

py-howto project now operational
by Andrew Kuchling Aug. 9, 2000

Aug. 9, 2000

I've just gotten around to setting up the checkin list for the Python HOWTO project on SourceForge (py-howto.sourceforge.net), so the project is now fully operational. People who want to update the HOWTOs, such as ESR and the curses HOWTO, can now go ahead and make changes. And this is the last you'll hear about the HOWTOs on python-dev; please use the Doc-SIG mailing list (doc-sig(a)python.org) for further discussion of the HOWTOs. --amk

1 0

Python HOWTO project created
by Andrew Kuchling Aug. 2, 2000

Aug. 2, 2000

[CC'ed to python-dev and doc-sig -- followups set to doc-sig] I've created a py-howto project on SourceForge to hold the Python HOWTO documents. http://sourceforge.net/projects/py-howto/ Currently me, Fred, Moshe, and ESR are listed as developers and have write access to CVS; if you want write access, drop me a note. Web pages and a py-howto-checkins mailing list will be coming soon, after a bit more administrative fiddling around on my part. Should I also create a py-howto-discuss list for discussing revisions, or is the doc-sig OK? Fred, what's your ruling about this? --amk

2 1