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

Status of "structured text"
by Mike F Miller Sept. 7, 2000

Sept. 7, 2000

I'm currently working on writing a medium sized tool that needs good embedded documentation, both for producing 'external' documents and for producing `-help` docs. I'd like to use the same string for both and have it formatted decently. For example, I'm thinking that having the ability to do something like... if __name__ == '__main__': """ This program runs a mpv test. The following options are available: (list the options, blah, blah, link, blah) """ help_re = re.compile("\-h(elp)?") for arg in sys.argv[1:]: if help_re.match(sys.argv[i]): print prettyparser(__doc__) # might be wrong syntax... Would be a really good thing. Of course this implies a python prettyparser module of some kind. I was thinking that something like it might exist to parse the structured text format, or will eventually need to exist to support the SIGs goals... Any thoughts or comments? Am I nuts, or should I try and write a structured text reformatter? Or a html->txt converter and use html instead? Thanks, - Mike

2 1

AW: [Doc-SIG] Status of "structured text"
by Jürgen Hermann Sept. 7, 2000

Sept. 7, 2000

-----Ursprüngliche Nachricht----- Von: Mike F Miller [mailto:mikem@ichips.intel.com] Gesendet: Donnerstag, 7. September 2000 00:38 Any thoughts or comments? Am I nuts, or should I try and write a structured text reformatter? Or a html->txt converter and use html instead? ---- HappyDoc (see recent anncouncement on comp.lang.python) contains a structured text module that parses such text and provides a class interface to it. Have a look... BTW, I think such a module should be part of Python 2.0 or 2.1 at least. Bye, Jürgen

1 0

Updated Distutils docs
by Greg Ward Sept. 7, 2000

Sept. 7, 2000

Hi all -- I've been slowly plugging away at the "Distributing Python Modules" manual over the last couple of days, and just uploaded the results to python.org. See http://www.python.org/sigs/distutils-sig/doc/ Especially the following sections of the "Distributing" manual: http://www.python.org/sigs/distutils-sig/doc/dist/describing-extensions.html http://www.python.org/sigs/distutils-sig/doc/dist/setup-config.html http://www.python.org/sigs/distutils-sig/doc/dist/source-dist.html http://www.python.org/sigs/distutils-sig/doc/dist/built-dist.html The "Installing Python Modules" manual has also been updated from the old copy that was on python.org, but this is mainly typo fixes (for now). Any feedback is welcome! Greg -- Greg Ward gward(a)python.net http://starship.python.net/~gward/

1 0