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 757411 - Reference GtkIconSize in argument/return documentation
Reference GtkIconSize in argument/return documentation
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: .General
3.19.x
Other Linux
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2015-10-31 13:08 UTC by Christoph Reiter (lazka)
Modified: 2016-01-04 11:02 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Mention GtkIconSize in all docs where the argument/return is annotated as taking an int instead of GtkIconSize (16.65 KB, patch)
2015-10-31 13:08 UTC, Christoph Reiter (lazka) 		committed Details | Review

Description Christoph Reiter (lazka) 2015-10-31 13:08:00 UTC 
In https://bugzilla.gnome.org/show_bug.cgi?id=601425 the annotations
were changed to int as they not only take the predefined enum values
but also user defined values registered through gtk_icon_size_register()

As a result the typelib doesn't contain any information about
GtkIconSize for those arguments and the Python docstring only
shows the corresponding Python type "int".

This changes the argument docs to mention the type explicitly
so the Python doc generator can add a link to Gtk.IconSize
which contains the most useful predefined values.

pgi-docgen bug: https://github.com/lazka/pgi-docgen/issues/104
Example docs: https://lazka.github.io/pgi-docs/#Gtk-3.0/classes/Button.html#Gtk.Button.new_from_icon_name
Comment 1 Christoph Reiter (lazka) 2015-10-31 13:08:59 UTC 
Created attachment 314544 [details] [review]
Mention GtkIconSize in all docs where the argument/return is annotated as taking an int instead of GtkIconSize
Comment 2 Christoph Reiter (lazka) 2016-01-04 11:01:33 UTC 
Comment on attachment 314544 [details] [review]
Mention GtkIconSize in all docs where the argument/return is annotated as taking an int instead of GtkIconSize

Someone on IRC said "just push it"..