I want to join the gtk+ documentation fest too!



Ho!

Attached is the patch to gtk.texi with GtkButton Relief user option
described.

Is there going to be any kind of coordination about adding missing parts to
gtk+ documentation. I propose that someone who is familiar with all of the
gtk+ features takes a glance at existing gtk.texi and just writes which
parts are missing/incomplete. Then volunteers could take some parts to
write.

Please note that I am from Croatia and lots of documentation contributors
are from non english speaking countries. It would be a good idea to have
someone to review the contributions at least for obvious spelling errors.

I saw that there are some stylistics inconsistencies in existing
documentation. E.g. indentation of paragraphs describing enumerated user
options is reverse somewhere. Look at the ButtonBox Widget around user
option 'layout_style' in contrary to Window Widget user option 'type'. Maybe
we should bring up a kind of style guide for such cases?

It is very good idea to add reference as "Derived from see section The xxx
widget" in Description section for each widget so you can backtrack the
inheritance of the widget.

The Base Widget is missing the description of state option. This is what I
will be doing next. Uhm, it's a small chunk, but, chunk by chunk and we
could have more complete documentation ;)

bb4now,
PMC

gtk.texi.patch



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]