Mailman 3 June 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

back up & running
by Fred L. Drake, Jr. June 28, 2000

June 28, 2000

My mega-laptop got fixed faster than I'd expected, so I'm back up to doing useful work. My top priorities are handling patches and going back through my email to find all the documentation patches that have sat idle for too long. -Fred -- Fred L. Drake, Jr. <fdrake at beopen.com> BeOpen PythonLabs Team Member

1 0

Python tutorial changes for 1.6?
by Dinu C. Gherman June 26, 2000

June 26, 2000

Hello, on the following page: http://www.python.org/doc/current/download.html I can read the this note: Note: The LaTeX sources are not being distributed as a package for this release since the documentation sources are being merged with the development version of the documentation in preparation for the Python 1.6 release. saying that the LaTeX files are currently not available. Could anybody provide some brief background information trying to outline what is expected to change apart from the pure content, i.e. LaTeX/format-unspecific material, especially for the Tutorial? I'm asking because I'd like to provide as soon as possi- ble an update of my German translation of Guido's 1.5.2 tutorial. And I might get somebody working on a more exo- tic translation of that tutorial, too, but would like to know if one can start confidently with 1.5.2 or should wait for the final 1.6 tutorial? Regards, Dinu -- Dinu C. Gherman ................................................................ "The only possible values [for quality] are 'excellent' and 'in- sanely excellent', depending on whether lives are at stake or not. Otherwise you don't enjoy your work, you don't work well, and the project goes down the drain." (Kent Beck, "Extreme Programming Explained")

1 0

Crystal 0.3
by Laurence Tratt June 10, 2000

June 10, 2000

Sorry for the wait, but after a long typing injury and with generous assistance Crystal 0.3 is available from: http://eh.org/~laurie/comp/python/crystal/ This version contains a command line interface, better HTML output and a few bug fixes. Because of its difficult period of gestation, YMMV. For those not in the know, Crystal is a pythondoc/javadoc type system. Laurie -- http://eh.org/~laurie/comp/python/

1 0

Python Docs' Translation
by Luca Manini June 7, 2000

June 7, 2000

Hi, I've just joined the list, I hope what follows is not off-topic. I'm studing Python in my spare time and I think I can try to translate some docs from English to Italian, may be starting with the Library Reference and the very interesting Extending and Embedding stuff. What should I do? If I understand well, the original source is LaTeX (with some ad-hoc macros). I'm quite fluent in LaTeX so this would be easy to work with. The questions are: is there a coordinator for this kind of effort, where should I get the sources from, where should I put the translated files? Any hint ? TIA, Luca.

6 12

Re: [Doc-SIG] htmldoc.py and inspect.py
by Juergen Hermann June 6, 2000

June 6, 2000

On Tue, 30 May 2000 02:43:54 -0700 (PDT), Ka-Ping Yee wrote: >I welcome your feedback! I'm currently using pdoc.py, and I will definitely will give your script a look. What I would like VERY much would be a Python doc system that shares as much as possible with the JavaDoc/DOC++/Doxygen world, especially the "commands" to provide semantic markup (like \param spam). Ciao, Jürgen -- Jürgen Hermann (jhe(a)webde-ag.de) WEB.DE AG, Amalienbadstr.41, D-76227 Karlsruhe Tel.: 0721/94329-0, Fax: 0721/94329-22

6 9

Re: Help with SSL in 1.6
by Fred L. Drake, Jr. June 5, 2000

June 5, 2000

Johannes Stezenbach writes: > configure doesn't seem to test for OpenSSL. > You must edit Modules/Setup manually (copy from Setup.in, > if necessary): And the SSL support doesn't appear to be documented anywhere. If anyone would like to document the socket.ssl() function and the SSL objects, I'd love to see a patch to the documentation, or just plain text for the new material. If anyone's interested, please drop me a note! -Fred -- Fred L. Drake, Jr. <fdrake at beopen.com> BeOpen PythonLabs Team Member

1 0

Re: htmldoc.py and inspect.py
by Karl Eichwalder June 2, 2000

June 2, 2000

Ka-Ping Yee <ping(a)lfw.org> writes: > On Wed, 31 May 2000, Walter Doerwald wrote: > > 50 years of computer science and I still can't type my name > > into an email. I'm really impressed! :-( Really? I can do it for you :) BTW, my name is easily written -- but people will fail to pronounce it correctly -- is this better? > *sigh* I know, it makes me really sad, too. >From time to time I receive e-mails with properly encoded eastern names. They are looking nice -- but my eyes are untrained to remember them. -- work : ke(a)suse.de | : http://www.suse.de/~ke/ | ------ ,__o home : ke(a)gnu.franken.de | ------ _-\_<, : http://www.franken.de/users/gnu/ke/ | ------ (*)/'(*)

1 0