After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 100309 - pygtk documentation scripts need to output docs for functions
pygtk documentation scripts need to output docs for functions
Status: RESOLVED OBSOLETE
Product: pygtk
Classification: Bindings
Component: documentation
1.99.x/2.0.x
Other Linux
: Normal enhancement
: ---
Assigned To: Nobody's working on this now (help wanted and appreciated)
Python bindings maintainers
Depends on:
Blocks:
 
 
Reported: 2002-12-04 10:42 UTC by Jon Kåre Hellan
Modified: 2006-07-08 23:24 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Jon Kåre Hellan 2002-12-04 10:42:01 UTC 
gtk.mainloop(), gtk.mainquit(), gtk.mainiteration() and gtk.events_pending()
are undocumented.

In general, this seems to be the case for everything which isn't part of
a class (e.g idle/timeout stuff, file handle stuff, etc.)

Some of these are lowlevel and need not be exported, but mainloop handling
has to exposed.
Comment 1 James Henstridge 2002-12-04 12:18:46 UTC 
simplifying summary ...
Comment 2 Johan (not receiving bugmail) Dahlin 2002-12-04 18:22:38 UTC 
This blocks bug 69243
Comment 3 James Henstridge 2002-12-05 01:07:52 UTC 
I think it is unrelated.  The other bug was about setting up
docstrings that gave you an idea of the expected parameters to the
functions.  This bug is about improving the scripts used to generate
the docbook / HTML documentation for PyGTK.
Comment 4 Johan (not receiving bugmail) Dahlin 2002-12-05 01:10:13 UTC 
Okay, perhaps.

Maybe we should fill a meta bug for documentation, to have all
documentation related bug depend on.
Comment 5 Johan (not receiving bugmail) Dahlin 2003-01-16 00:09:48 UTC 
The question in for documentation for functions is where we want to
put it.

Inline in the code or separated, in xml or something similar?
Comment 6 Xavier Ordoquy 2004-04-01 05:57:13 UTC 
Any news on that bug ???
Comment 7 Christian Reis (not reading bugmail) 2004-04-02 00:40:12 UTC 
These are docs issues with PyGTK, not gnome-python. Changing component.
Comment 8 Christian Reis (not reading bugmail) 2004-04-02 00:40:39 UTC 
John, what do you say about this?
Comment 9 John Finlay 2004-04-02 01:27:03 UTC 
If this bug is about scripts to generate docs as stated by James, it seems to be
out of my realm of expertise. If not then I'd need more info to understand the
exact concern. If it's a concern that the docs are missing some method or
function descriptions then I could deal with that given a list of missing items.
AFAICT this bug report predates the current ref docs.
Comment 10 Christian Reis (not reading bugmail) 2004-04-13 13:49:16 UTC 
Dang. I lost a huge comment I wrote here analyzing the functions that still
needed documenting. John, would it be useful if I went through the work of
summarizing them again.
Comment 11 John Finlay 2004-04-13 16:47:13 UTC 
It's always useful to have an understanding of what someone else thinks is
missing from the docs otherwise I'm left to my own devices  and faulty memory. :-)
It would also be the start of a good TODO list.