GNOME Bugzilla – Bug 571834
Documentation for Python GIO bindings is missing
Last modified: 2009-05-17 14:57:17 UTC
Documentation Section: pygtk? It does not mention GIO at all. Correct version: It should document GIO. Other information: Developers are not happy: http://ubuntuforums.org/showpost.php?p=6738023&postcount=126
(In reply to comment #0) > Documentation > Section: pygtk? > It does not mention GIO at all. Yup documentation for GIO is not yet available (nobody has started writing the docs) > Correct version: > It should document GIO. Ehmmm... yes it should. > Other information: > Developers are not happy: > http://ubuntuforums.org/showpost.php?p=6738023&postcount=126 If developers are not happy, and I can understand that, they should pop in #pygtk and offer some help in writing it. Please note that it can sound harsh but it's not, that's what I did many years ago when I started contributing to Gnome.
I was following the bug tracker instructions, that's why the text is there. I'll ask the developer on helping to write it - but I have a feeling he wanted to use the documentation, not write it.
There is some minimalistic and incomplete documentation in .defs files, but it seems to be unused (except from Python built-in help which probably no-one seriously uses). Even some auto-generated help with at least lists of functions and these short blurbs (where available) would be an improvement.
(In reply to comment #2) > I was following the bug tracker instructions, that's why the text is there. Of course Vadim, don't get me wrong thanks a lot for your bug report. > I'll ask the developer on helping to write it - but I have a feeling he wanted > to use the documentation, not write it. eheh this is what I meant, everybody wants to _use_ it, but it takes a lot of effort in writing it.
Well, less people want to use it if it's not there. It's not like open-source programs can only benefit from 'everyone' wanting to use it ;)
Open Source is a community. It works best when people who see a need (esp. for themselves) willingly pitch in to help satisfy that need.
Sure, and that is why the program is being made to begin with. But it is a turn off when the tools are of poor quality / lacking.
*** Bug 578067 has been marked as a duplicate of this bug. ***
It's a work in progress, I've already wrote the docs for quite some classes, see SVN trunk.
Great, thank you
Some parts are still missing, we could use some help. I'm closing as fixed since with or without help we are going to finish it.