search

pygobject / pgi-docgen

API Documentation Generator for PyGObject
https://lazka.github.io/pgi-docs/
GNU Lesser General Public License v2.1
127 stars 36 forks source link

TreeModelRow is missing docs #86

Closed lazka closed 8 years ago

lazka commented 9 years ago

It's quite important for TreeModel related things, so do this one first:

https://lazka.github.io/pgi-docs/#Gtk-3.0/classes/TreeModelRow.html

tobias47n9e commented 9 years ago

I was also just looking at that page and wondering why it was empty. I don't think things changed too much from PyGTK:

http://www.pygtk.org/pygtk2reference/class-pygtktreemodelrow.html http://www.pygtk.org/pygtk2reference/class-pygtktreemodelrowiter.html

What I noticed is that TreeModelRow.iterchildren() now always returns a Gtk.TreeModelRowIter-object (even if there are no children) as opposed to returning None in PyGTK. Then calling Gtk.TreeModelRowIter.next() raises the StopIteration on the first iteration.

It might also be a good idea to put a link to the following page at TreeModelRow.iterchildren() :

https://lazka.github.io/pgi-docs/#Gtk-3.0/interfaces/TreeModel.html#Gtk.TreeModel.foreach

It is probably what people are sometimes looking for when they want to iterate over the children of a TreeView.