Mailman 3 June 1999 - Doc-SIG

turtle.py
by Gerrit Holl June 29, 1999

June 29, 1999

Hallo, why isn't turtle.py in the list of undocumented modules? groeten, Gerrit. -- The Dutch Linuxgames homepage: http://linuxgames.nl.linux.org Personal homepage: http://www.nl.linux.org/~gerrit/ Discoverb is a python program (in several languages) which tests the words you learned by asking it. Homepage: http://www.nl.linux.org/~gerrit/discoverb/

2 3

soundex module status?
by Skip Montanaro June 29, 1999

June 29, 1999

At one point Guido talked about obsoleting the soundex module. I didn't see it on the list of undocumented modules but also didn't see an "this module is obsolete" comment in the code. It's a very simple modules (defines two module methods, defines no objects, makes no significant external calls). I've been meaning to get around to using it in Musi-Cal, but it's always been low enough priority that it's never gotten done. (As Don Beaudry says, "so much code, so little time".) What's its current status? I'll be happy to whip up a simple latex file for it if that saves its life. If it's deemed unworthy of continued module-hood, I propose it simply be moved into the Demo directory. Skip Montanaro | http://www.mojam.com/ skip(a)mojam.com | http://www.musi-cal.com/~skip/ 518-372-5583

4 6

Patches to pythondoc 0.6
by Konrad Hinsen June 28, 1999

June 28, 1999

There were two bugs in pythondoc that I found sufficiently annoying to warrant an exploration: 1) Markup in oneliners was not taken into account. 2) Markup for a single letter didn't work. Here's the patch: diff -r -c pythondoc-0.6/docregex.py pythondoc-0.6-fixed/docregex.py *** pythondoc-0.6/docregex.py Sat May 1 03:01:15 1999 --- pythondoc-0.6-fixed/docregex.py Mon Jun 28 16:52:34 1999 *************** *** 37,47 **** # Strong: # format: "**strong text**" ! strong_regex=re.compile(startm + "\*\*(?P<text>[^ \t][^\n*]*[^ \t])\*\*" + endm, re.MULTILINE) # Emphasized: # format: "*emphasized*" ! emph_regex = re.compile(startm + "\*(?P<text>[^ \t][^\n*]*[^ \t])\*" + endm, re.MULTILINE) # Bullet: # format: "* bulleted list" --- 37,47 ---- # Strong: # format: "**strong text**" ! strong_regex=re.compile(startm + "\*\*(?P<text>[^ \t]([^\n*]*[^ \t])?)\*\*" + endm, re.MULTILINE) # Emphasized: # format: "*emphasized*" ! emph_regex = re.compile(startm + "\*(?P<text>[^ \t]([^\n*]*[^ \t])?)\*" + endm, re.MULTILINE) # Bullet: # format: "* bulleted list" diff -r -c pythondoc-0.6/stdmarkup.py pythondoc-0.6-fixed/stdmarkup.py *** pythondoc-0.6/stdmarkup.py Sat May 1 03:09:09 1999 --- pythondoc-0.6-fixed/stdmarkup.py Mon Jun 28 16:48:00 1999 *************** *** 97,103 **** def create_tree_Object(self, docobj): """Default implementation for generating doctrees.""" self.trace_msg("Creating tree for %s %s" % (docobj.tag(), docobj.name()), 2) ! oneliner, doc = docstring.split_doc(docobj.docstring()) try: oneliner = eval("self.fix_oneliner_%s(oneliner)" % docobj.tag()) except AttributeError: --- 97,103 ---- def create_tree_Object(self, docobj): """Default implementation for generating doctrees.""" self.trace_msg("Creating tree for %s %s" % (docobj.tag(), docobj.name()), 2) ! oneliner, doc = docstring.split_doc(docobj.docstring()) try: oneliner = eval("self.fix_oneliner_%s(oneliner)" % docobj.tag()) except AttributeError: *************** *** 107,113 **** st = StructuredText.StructuredText(doc) if oneliner: ! self.__doctree.add_child(doctree.Oneliner(oneliner)) marker = doctree.DocNode('', 'Marker') self.__doctree.add_child(marker) --- 107,115 ---- st = StructuredText.StructuredText(doc) if oneliner: ! node = doctree.Oneliner('') ! self._create_markup_node(oneliner, node) ! self.__doctree.add_child(node) marker = doctree.DocNode('', 'Marker') self.__doctree.add_child(marker) -- ------------------------------------------------------------------------------- Konrad Hinsen | E-Mail: hinsen(a)cnrs-orleans.fr Centre de Biophysique Moleculaire (CNRS) | Tel.: +33-2.38.25.55.69 Rue Charles Sadron | Fax: +33-2.38.63.15.17 45071 Orleans Cedex 2 | Deutsch/Esperanto/English/ France | Nederlands/Francais -------------------------------------------------------------------------------

1 0

Undocumented modules update.
by Fred L. Drake June 19, 1999

June 19, 1999

Thanks to Moshe Zadka, a number of modules are making they're way to the "documented" list. I've appended an updated list of undocumented modules; I generate the from the Doc/ directory using the command: ./tools/listmodules -cbi paper-letter/modlib.idx -i paper-letter/modmac.idx (This requires that the DVI or PDF version of the documentation has been built, to get the .idx files that list what's been documented.) -Fred -- Fred L. Drake, Jr. <fdrake(a)acm.org> Corporation for National Research Initiatives <builtin> pcre strop <extension> _locale cl curses dl fpectl fpetest nis pure sgi stdwin sv timing <standard> asynchat asyncore audiodev bdb chunk codeop dircmp dospath dump find grep htmlentitydefs ihooks knee macurl2path mutex ntpath nturl2path packmail pipes posixpath pty reconvert regex_syntax rlcompleter sched statvfs sunau sunaudio toaiff tty tzparse lib-tk Canvas Dialog FileDialog FixTk ScrolledText SimpleDialog Tkconstants Tkdnd Tkinter tkColorChooser tkCommonDialog tkFileDialog tkFont tkMessageBox tkSimpleDialog turtle plat-* CD CDIO CDROM CL CL_old ERRNO FCNTL FILE GET GLWS IN IOCTL SOCKET STROPTS SUNAUDIODEV SV WAIT cddb cdplayer panel panelparser readcd torgb

5 4

DocBook formatter for pythondoc
by Konrad Hinsen June 17, 1999

June 17, 1999

I have put a first version of a DocBook formatter for pythondoc 0.6 on my ftp site (ftp://dirac.cnrs-orleans.fr/pub/DocBookFormatter.py). It doesn't yet support all possible markup, and probably never will, because pythondoc is much too layout-oriented for DocBook. For example, it is impossible to have just a "title" in DocBook, titles are always associated with structural units (chapters, sections, etc.). Nevertheless, the DocBook formatter is quite useful when used on appropriate doc strings. The goal of my formatter is to produce reference chapters for end user documentation. Therefore I have introduced an option that I think would be useful for other formatters as well: when you specify the Option "DocBook_undocumented=0", no documentation will be generated for items that have no doc string. I use this to exclude methods like __add__ from end user documentation; instead I mention in the doc string of the class that the class supports addition. If you look at the code, you will notice two methods that are commented out and replaced with different ones. These are the methods that generate function and method documentation. The original (now commented) versions produce the "proper" markup according to the DocBook reference, but unfortunately the existing DocBook stylesheets were made with C in mind and produce C syntax for every function call! I hope this will change in later versions, but until then I prefer to use less specific markup that produces Python syntax. -- ------------------------------------------------------------------------------- Konrad Hinsen | E-Mail: hinsen(a)cnrs-orleans.fr Centre de Biophysique Moleculaire (CNRS) | Tel.: +33-2.38.25.55.69 Rue Charles Sadron | Fax: +33-2.38.63.15.17 45071 Orleans Cedex 2 | Deutsch/Esperanto/English/ France | Nederlands/Francais -------------------------------------------------------------------------------

1 0