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 752088 - Improve GtkImageMenuItem documentation to reflect deprecation status
Improve GtkImageMenuItem documentation to reflect deprecation status
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
unspecified
Other Linux
: Normal enhancement
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2015-07-07 17:17 UTC by Eric Williams
Modified: 2015-07-08 03:19 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Improved short description for gtkimagemenuitem.c (827 bytes, patch)
2015-07-07 17:18 UTC, Eric Williams 		committed Details | Review

Description Eric Williams 2015-07-07 17:17:07 UTC 
For widgets that are deprecated, it would be nice to have the widget's short description reflect its deprecation status.

For example, on the GtkColorSelection reference page, the description reads:
"GtkColorSelection — Deprecated widget used to select a color"
(https://developer.gnome.org/gtk3/stable/GtkColorSelection.html)

Since GtkImageMenuItem has been entirely deprecated, it would be nice to add this to the description, perhaps something like:
"A deprecated widget for a menu item with an icon"
(https://developer.gnome.org/gtk3/stable/GtkImageMenuItem.html)


This will let developers know right away that the entire widget has been deprecated.
Comment 1 Eric Williams 2015-07-07 17:18:06 UTC 
Created attachment 307028 [details] [review]
Improved short description for gtkimagemenuitem.c
Comment 2 Emmanuele Bassi (:ebassi) 2015-07-07 17:28:42 UTC 
Review of attachment 307028 [details] [review]:

Looks good.