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

Pythondoc installation bugs (and fixes)
by Stuart Reynolds March 31, 2000

March 31, 2000

Hi Guys, I've just installed Pythondoc (0.7) on my system and there's some bugs in the installation (this is on Solaris with python 1.5.2). [BTW. Does anyone know how to contact Daniel Larson? His address, Daniel.Larsson(a)vasteras.mail.telia.com, keeps bouncing mail back to me.] - The Makefile contains some illegal end of line characters that cause it not to work with some versions of make. To fix run, .../Pythondistrib/Tools/scripts/crlf.py Makefile - Similarly, there's something wrong with the first line of the "pythondoc" file that crlf.py fixes, % ./pythondoc /usr/bin/env: No such file or directory % crlf.py ./pythondoc pythondoc % ./pythondoc [works] - when the installation zip file is unzipped, some of the files it outputs don't have the user write permissions set (this is just irritating). - the Makefile - it doesn't copy "gui.py" into the package directory. - After fixing these and then running "make test", I get % make test Building HTML4 output for pythondoc in /tmp/html. pythondoc sources in the current directory will be sh: syntax error at line 1: `(' unexpected *** Error code 2 make: Fatal error: Command failed for target `test' But otherwise the program works fine. Its a top tool. Cheers, Stuart PS. The web page at, http://starship.skyport.net/crew/danilo/pythondoc/ stills list v0.4 as the latest version. Also, the "latest version" link at http://starship.python.net/crew/danilo/pythondoc/README.html also points to the v0.4 page.

1 0

Another urllib doc glitch
by Ka-Ping Yee March 30, 2000

March 30, 2000

Looks like some sort of TeX conversion problem -- the "quote" and "unquote" sections don't display the tilde characters as intended, so they look puzzling: Example: quote('/connolly/') yields '/%7econnolly/'. Example: unquote('/%7Econnolly/') yields '/connolly/'. The examples were probably intended to read Example: quote('/~connolly/') yields '/%7econnolly/'. Example: unquote('/%7Econnolly/') yields '/~connolly/'. -- ?!ng

2 2

Where do the HOWTO .tex sources live?
by pf＠artcom-gmbh.de March 30, 2000

March 30, 2000

Hi! I wonder where the .tex sources of the several HOWTO documents live. They are obviousy not part of the Python doc source sub tree (with the exception of the Mac lib and Fred's doc meta howto). Regards, Peter

2 1

Documentation work plan
by Fred L. Drake, Jr. March 27, 2000

March 27, 2000

This plan doesn't deal with source-embedded documentation; I'm hoping that someone will write software to do the extraction. If you want it, please write the extractor and I can write the integration into this plan. ;) I sketched this out last night while tired, and filled it out a little in a rush this morning. I'm open for comments. Python Documentation Attack Plan ================================ 1. "Long" HTML format This will be a package that contains an HTML version of the documentation formatted to be one HTML file per chapter. This is primarily for the convenience of on-demand publishers interested in keeping their Python material up-to-date. Everyone is welcome to use this, however. This will be released this week. 2. Merge 1.5.2p2 patches into 1.6 development tree Time to review the CVS manual again! This will be fairly tedious, since the 1.5.2p2 sources changed substantially more than I'd expected. I'll work on this over the next few weeks one manual at a time. Don't ask how many a "few" is -- I honestly don't know. 3.a. Update for 1.6 Integrate the Unicode documentation, update the documentation for strings and the string module to reflect the addition of string methods. Add documentation for more modules. Complete the Python/C API manual. b. Write DTD for SGML documentation Propose a specific DTD. It will likely shift a little as the conversion is finallized and the first formatting is implemented. 4. Release for 1.6 This will still be from the LaTeX sources, due to the accelerated release schedule for Python 1.6. 5.a. Wrap up conversion scripts Finalize the LaTeX-to-SGML conversion. b. Develop SGML->HTML conversion Make the SGML useful. This needs to be a very solid conversion since this is what most people use and be, at first, the only available formatting of the documents. 6.a. Transfer maintenance to SGML No more delays! b. Release from SGML Put the HTML & SGML in people's hands without requiring CVS access. 7. Develop typeset formats from SGML We need at least one typeset version for old fogeys like me. Probably still PDF & PostScript in two paper sizes. 8. Release all formats from SGML Let them kill trees! -Fred -- Fred L. Drake, Jr. <fdrake at acm.org> Corporation for National Research Initiatives

1 0

download size
by Hernan Martinez Foffani March 26, 2000

March 26, 2000

On Sun, 26 Mar 2000 14:01:44 I wrote: > >May be including a table like this in the html .... >I know it's more work, but with a little python script... No, don't look at me :-) Just to follow python community spirit: template = "<TR><TD>%s</TD><TD>%s</TD><TD><A HREF=" + \ "http://www.python.org/doc/current/download/" + \ "%s>%s</A></TD><TD>%d KB</TD></TR>" templtitle = "<TR><TD>%s</TD><TD>%s</TD><TD>%s</TD><TD>%s</TD></TR>" download = [ ( "Acrobat", "A4", "doc-a4.pdf", "doc-a4.pdf", 1500 ), ( "Acrobat", "Letter", "doc-letter.pdf", "doc-letter.pdf", 1501 ), ( "HTLM zip", "N/A", "html.zip", "html.zip", 1122 ) ] def showtable() : print "<TABLE>" print templtitle % ( "Doc Format", "Page Size", "URL", "Size" ) for docformat in download: print template % docformat print "</TABLE>" BTW, it almost took me more time to sketch the table with -, | and + than to sketch the script. You'll do better, of course. -H. --- Hernan Martinez Foffani hernanf(a)my-deja.com --== Sent via Deja.com http://www.deja.com/ ==-- Share what you know. Learn what you don't.

1 0

Re: [Doc-SIG] MS HTML Help of 1.5.2 rel March 22 docs
by Hernan Martinez Foffani March 26, 2000

March 26, 2000

On Sat, 25 Mar 2000 23:29:56 Fred L. Drake, Jr. wrote: > I still need to add download size information to that page, since >that's been requested a number of time. If anyone has a specific >suggestion about *how* that should be presented, I'd love to hear it! May be including a table like this in the html page?: DOWNLOAD THE FORMAT THAT FITS BEST TO YOU! +-----------------------------------+------+ | Doc. Format | Page Sz. | URL | Size | +-------------+----------+----------+------+ | | A4 | bla4.pdf | 4 MB | | Acrobat +----------+----------+------+ | | Letter | blalt.pdf|3.9MB | +-------------+----------+----------+------+ | | | | | etc. You get the idea. I know it's more work, but with a little python script... No, don't look at me :-) BTW, thanks for your words. Regards, -Hernan --== Sent via Deja.com http://www.deja.com/ ==-- Share what you know. Learn what you don't.

1 0

MS HTML Help of 1.5.2 rel March 22 docs
by Hernan Martinez Foffani March 26, 2000

March 26, 2000

[posted in comp.lang.python.announce] The latest version of Microsoft HTML Help of Python 1.5.2 release Mar 22 2000 docs is ready for download at http://www.orgmf.com.ar/condor/pytstuff.html And now it keeps the last size of the window opened! (I believe that someone asked for this a year ago...:-) Description: As you all know, the docs of Python are distributed in a bunch of html files. With MS HTML Help file you get all the docs in 1 compressed file of 1.6MB that has a unified content tree and full text search. Have fun, Hernan. --- Hernan Martinez Foffani hernanf(a)my-deja.com --== Sent via Deja.com http://www.deja.com/ ==-- Share what you know. Learn what you don't.

2 2

Work plan forthcoming
by Fred L. Drake, Jr. March 24, 2000

March 24, 2000

A couple of people have asked me "What's next?", so I'm going to write up a little plan of attack and post it to the list next week. I simply haven't had time to write it yet. Just be aware that it's coming, so you don't have to ask. ;) -Fred -- Fred L. Drake, Jr. <fdrake at acm.org> Corporation for National Research Initiatives

1 0