[pygtk] Documentation

[standa_1 at centrum.cz]

First, I want to thank all people who created pygtk, make it work and documented. I have no mutch experience with pygtk, so the documentation is the very important for me and poeple like me. Docs is good. But is not perfect. There are moments, when I have no problem finding whatever I'm looking for, but sometimes I need just a little piece of information and I'm stuck for (sometimes) an hour or maybe more. And i'm really upset because if this little piece of information would be in place, i could have all my job done with smile on my face.

So I have some tips about documentation:
1. it would be great to have an option to enter my thoughts, tips, misunderstandings right on the documentation page. Like PHP does. I think it's good. IE i needed to create dialog box. It was simple. In last paragraph (dialog class) - ... you can call run()... Fine. Dialog appeared, but there is no info, what to do next. How to make it disappear. All what I was missing was - for closing the dialog call function destroy(). It took me 30min. I'd like to add this info to docs (or pass this info to maintainer of the docs), but how? Creating account in bugzilla and filling bug report is too "heavy" process to take just for sending this little info. Sending an email to some email account created for this purpose would be easier, but still not as simple as form directly on the docs page. And I think, there is plenty of "little informations" that could be collected from users.

2. While viewing info about classess there are viewed only methods and signals from the displayed class. But there are a lot of other methods form ancestors. It would be great to have all methods displayed in place. Like javadocs has. I think it's good. There could be problem, because som classess has a lot of methods and displaying all ancestors methods altogether can make a really long list. But there could be solutions how to accomplish it.

I'd be glad to have a feedback from poeple responsible for docs. If this ideas would be good to implement i'd like to help with it.

standa.