[Doc-SIG] Re: two subjects: docutils for python docs, and integrating documentation in source code

Martin Blais martin.blais at gmail.com
Sat Apr 30 22:00:15 CEST 2005


On 4/30/05, Felix Wiemann <Felix.Wiemann at gmx.net> wrote:
> Martin Blais wrote:

> > - there is no way to declare the base classes.  The problem is that the syntax
> >   for the constructor (documentation) takes the space of inheritance (source
> >   code);
> 
> I don't understand.  Could you elaborate (maybe with an example),
> please?

look at, for example, class Decimal in the docs:
http://docs.python.org/lib/node177.html

class Decimal(  	[value [, context]])
    Constructs a new Decimal object based from value.

in the source code, the declaration:

   class ClassName(...):

has ... replaced by the base class.  in the docs, it's used for the
constructor.  this is only slightly confusing.

so then, where do you declare a base class?

cheers,


More information about the Doc-SIG mailing list