Re: Improving PyGObject documentation

[Jonathan Ballet <jon multani info>]

Hi Sebastian,

On Mon, Feb 11, 2013 at 08:55:32AM -0500, Sebastian Pölsterl wrote:
> Dear Jonathan,
>
> I don't see it as an API reference manual, because that would mean that
> one has to maintain that manually and update it if the C reference
> changes. Ultimately, this will lead to the python reference being behind
> the C reference all the time.

Yes, that's the problem I was actually thinking of. But seeing things
like this
http://python-gtk-3-tutorial.readthedocs.org/en/latest/treeview.html#Gtk.TreeModel
for example, the boundary is very thin.
How far this tutorial is this kind of documentation is "supposed" to go?

> My main purpose was indeed to write a tutorial with examples and
> documentation for the functions and classes that were used in this
> example. If you want to add additional examples which explain widgets
> that are currently not part of the tutorial, I'd be happy to add them.

I'll probably submit some updates then. What would be the process to
submit things? (where, how?)

Thanks,

 Jonathan


> Best regards,
> Sebastian
>
> Am 10.02.2013 06:25, schrieb Jonathan Ballet:
> > Hi,
> >
> > I'm currently working on an application which uses PyGObject and Gtk 3.
> > I used once or twice the informations provided in
> > http://python-gtk-3-tutorial.readthedocs.org/ but I mostly refers to the
> > official Gtk 3 documentation, which describes the C API.
> >
> > There are some differences between the C API and the API provided in
> > Python (often, the later is more convenient :) which is not documented
> > in the link mentioned above.
> > I'm willing to help to improve this document, but I wonder what its
> > scope is: is it more like a tutorial with a few API references and a
> > 'for more information, look at the C API', or is it supposed to become
> > eventually complete by itself?
> > My actual question would actually probably be: what to put inside?
> > Examples, explanations, missing API, ?
> >
> > Regards,
> >
> >  Jonathan