Mailman 3 July 1999 - Doc-SIG

docstrings for re.py?
by Jeffrey Chang July 12, 1999

July 12, 1999

Has anyone added docstrings to re.py? If not, then I will go ahead and do it. I'm tired of having to consult the reference manual! ;) Jeff

5 7

Re: [Doc-SIG] Sort order in pythondoc
by Konrad Hinsen July 9, 1999

July 9, 1999

> It should be possible if you believe the reference manual, > where in chapter "3.2 - The standard type hierarchy", where > you can read under "Internal types" -> "Code objects" (second > paragraph): ... Indeed, that works. Here is my code to extract a sort index: def sort_index(self): """Returns a line number from the object's definition in the source code module, used to have the documentation use the same order as the source code within one type of object.""" import types t = type(self.__object) if t is types.FunctionType: return self.__object.func_code.co_firstlineno elif t is types.MethodType or t is types.UnboundMethodType: return self.__object.im_func.func_code.co_firstlineno elif t is types.ClassType: for att in self.__object.__dict__.values(): if type(att) is types.FunctionType: return att.func_code.co_firstlineno raise ValueError, "no sort index defined" Konrad. -- ------------------------------------------------------------------------------- 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

Sort order in pythondoc
by Konrad Hinsen July 8, 1999

July 8, 1999

When I create documentation with pythondoc, I get all classes in a module sorted alphabetically by name. In most cases that's not at all what I want; I'd prefer to have them in the same order as in the source code. That would prevent trivial subclasses to appear before their base classes, for example. Unfortunately, I don't see any way to do this, because it seems that the source code order is lost after a module is imported. Or maybe not, I am not an expert on Python internals. Does anyone know a trick how this information could be recovered? Konrad. -- ------------------------------------------------------------------------------- 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 -------------------------------------------------------------------------------

2 1

Documenting extension modules
by Konrad Hinsen July 6, 1999

July 6, 1999

Having added docstrings to many of my Python modules, I'd now like to work on some of my C extension modules. Adding docstrings to them is not much of a problem, but they seem to be much less useful. Pythondoc cannot get information such as argument names from an extension modules, and some doc strings seem to be completely inaccessible, for instance those for methods in types. Is there any convention for documenting extension modules, and does pythondoc provide any support for it? Konrad. -- ------------------------------------------------------------------------------- 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