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 778534 - Widget: Document signal mnemonic-activate
Widget: Document signal mnemonic-activate
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2017-02-12 15:49 UTC by Daniel Boles
Modified: 2017-02-15 21:47 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
widget: Document signal mnemonic-activate (1.71 KB, patch)
2017-02-12 15:53 UTC, Daniel Boles 		committed Details | Review

Description Daniel Boles 2017-02-12 15:49:56 UTC 
Currently the signal itself has no documentation and an anonymous extra argument:
https://developer.gnome.org/gtk3/stable/GtkWidget.html#GtkWidget-mnemonic-activate

To figure out how to use the signal, the user must realise that the emit method _is_ documented:
https://developer.gnome.org/gtk3/stable/GtkWidget.html#gtk-widget-mnemonic-activate

This isn't very obvious. I propose properly naming the argument in the signal, and moving the explanatory paragraph to there too. (Then the method already links back to the signal, in case anyone gets there first.)
Comment 1 Daniel Boles 2017-02-12 15:53:06 UTC 
Created attachment 345578 [details] [review]
widget: Document signal mnemonic-activate
Comment 2 Matthias Clasen 2017-02-15 21:13:12 UTC 
Review of attachment 345578 [details] [review]:

Looks fine to me; even if this is really mostly internal-use
Comment 3 Daniel Boles 2017-02-15 21:46:58 UTC 
Comment on attachment 345578 [details] [review]
widget: Document signal mnemonic-activate

Thanks!