Re: Improving PyGObject documentation

[Adam Tauno Williams <awilliam whitemice org>]

On Thu, 2013-02-14 at 10:36 +0100, Jonathan Ballet wrote:
> 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?

It is a legitimate question;  but telling someone to go look at the
C-docs is also (a) not great marketing and (b) will scare people off.

BTW, these docs are great.  Especially TreeView, ListStore, and there
brethren can be very hard to get a grasp on.

> > 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?)

-- 
Adam Tauno Williams  GPG D95ED383
Systems Administrator, Python Developer, LPI / NCLA