GNOME Bugzilla – Bug 656047
Update documentation on pygtk.org
Last modified: 2011-08-06 17:12:43 UTC
gtk.Assistant documentation (http://www.pygtk.org/docs/pygtk/class-gtkassistant.html) does not document commit() method. It's description should be something similar to gtkmm: Erases the visited page history so the back button is not shown on the current page, and removes the cancel button from subsequent pages. Use this when the information provided up to the current page is hereafter deemed permanent and cannot be modified or undone. For example, showing a progress page to track a long-running, unreversible operation after the user has clicked apply on a confirmation page.
Does pygtk.org still have links to pygtk.org/docs? Anyway, you should have a look at http://developer.gnome.org/pygtk/stable/ and specifically http://developer.gnome.org/pygtk/2.24/class-gtkassistant.html#method-gtkassistant--commit
pygtk link to gnome docs, but Google still find pygtk.org/docs. Should you change pygtk.org/docs to point to docs on gnome.org?
Hmm, maybe updating pygtk.org/docs would be better, who knows how many websites still point to that location... I checked out the pygtk-web module and have started preparing some (unrelated) patches. Haven't figured out yet how to properly update pygtk.org/docs though as it uses a Makefile that fetches some documentation tarballs left and right. Don't know if that's still desirable or not. Pachi, any hints?
The Makefile fetches some tarballs from some remote machines as the docs were built there (for convenience). As docs are now available from developer.gnome.org we should probably kill that part. Dieter, feel free to change that part of the Makefile, as I'm just leaving on vacation and I'm not sure I will be able to have a look to it before the end of august. That said, I should probably file a bug for d.g.o as I still keep using the old docs as the style is much more compact and easier to use than the current one.
(In reply to comment #4) > The Makefile fetches some tarballs from some remote machines as the docs were > built there (for convenience). As docs are now available from > developer.gnome.org we should probably kill that part. > > Dieter, feel free to change that part of the Makefile, Yeah, had a closer look this morning. Short therm, I think replacing pygobject and pygtk documentation tarballs in REFTARBALLS with up to date versions in the documentation directory (LOCAL_TARBALLS) might do the trick. I'll see what I can do to make updated (and fixxrefs.py-ed) pygobject/pygtk-docs tarballs this afternoon. That way we still have a more sane layout and we don't break links all over the web... Long term, those locations should probably redirect to d.g.o (when the issue below is fixed), but we'll need some help from the infra team, I guess... Eerm, do I just commit and the rest happens automatically? > as I'm just leaving on > vacation and I'm not sure I will be able to have a look to it before the end > of august. Have a nice vacation! > That said, I should probably file a bug for d.g.o as I still keep using the > old docs as the style is much more compact and easier to use than the current > one. Part of that is probably bug #644666, but nobody seems to care much...
Yes, you can commit and the Makefile is run automagically.
(In reply to comment #6) > Yes, you can commit and the Makefile is run automagically. Committed, pushed and after a browser refresh both www.pygtk.org/docs/pygobject and www.pygtk.org/docs/pygtk reference docs have been updated. REFTARBALLS are now treated more like LOCAL_TARBALLS in the makefile and the REFDISTDIR variable has been removed. Let me know if I did something extraordinarily stupid though... Thanks for the report Petr and thanks for the guidance Patchi!