[pygtk] Documentation strategy for bindings

[BJörn Lindqvist]

On 9/3/07, Lauro Moura <lauromoura at gmail.com> wrote:
> On 9/3/07, BJörn Lindqvist <bjourne at gmail.com> wrote:
> > Hello!
> >
> > I'm interested to know what the best way (or maybe there are multiple
> > good ways) to write documentation for Python bindings for a GTK
> > library is.
> >
> > What I would like, is for a way to get the documentation into the
> > docstrings, because then I get interactive help and can generate html
> > and pdfs using epydoc. However I'm not sure if the wrapper generator
> > in pygtk supports that? And even if it does, wouldn't it be a royal
> > pain in the ass to have to update all the documentation each time I
> > regenerate the wrapper?
> >
>
> There's an optional argument for definitions: docstring. To use, add
>
> (docstring "foo bar") in Class, function or method definitions.
>
> Source: Changelog entry for 2006-04-01.

Hmm yes. But it is not exactly perfect if you have multi paragraph
comments or want to document module variables or signals.

-- 
mvh Björn