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 728350 - gaction: Minor clarifications in the GAction documentation
gaction: Minor clarifications in the GAction documentation
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
unspecified
Other All
: Normal normal
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2014-04-16 15:29 UTC by Philip Withnall
Modified: 2014-04-23 13:47 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
gaction: Minor clarifications in the GAction documentation (1.65 KB, patch)
2014-04-16 15:29 UTC, Philip Withnall
needs-work Details | Review
gaction: Minor clarifications in the GAction documentation (1.41 KB, patch)
2014-04-23 12:03 UTC, Philip Withnall
committed Details | Review

Description Philip Withnall 2014-04-16 15:29:20 UTC
Patch attached.
Comment 1 Philip Withnall 2014-04-16 15:29:22 UTC
Created attachment 274468 [details] [review]
gaction: Minor clarifications in the GAction documentation
Comment 2 Matthias Clasen 2014-04-23 02:13:16 UTC
strings can only be NULL if that is explicitly mentioned. Adding these clarifications all over the place only muddies the picture.
Comment 3 Allison Karlitskaya (desrt) 2014-04-23 03:17:14 UTC
Review of attachment 274468 [details] [review]:

I agree.

::: gio/gaction.c
@@ +87,3 @@
    *
    * The name of the action.  This is mostly meaningful for identifying
+   * the action once it has been added to a #GActionGroup. It is immutable and

Please remove the "must not be %NULL" here.

@@ +105,3 @@
    * The type of the parameter that must be given when activating the
+   * action. This is immutable, and may be %NULL if no parameter is needed when
+   * activating the action.

This is fine (and actually helpful).

@@ +139,3 @@
    *
    * The #GVariantType of the state that the action has, or %NULL if the
+   * action is stateless. This is immutable.

Also fine.

@@ +238,3 @@
  * Queries the name of @action.
  *
+ * Returns: the name of the action, which must not be %NULL

Please remove this one.
Comment 4 Philip Withnall 2014-04-23 12:03:09 UTC
Created attachment 274941 [details] [review]
gaction: Minor clarifications in the GAction documentation
Comment 5 Allison Karlitskaya (desrt) 2014-04-23 12:50:50 UTC
Review of attachment 274941 [details] [review]:

Looks good.  Thanks.
Comment 6 Philip Withnall 2014-04-23 13:46:49 UTC
Thanks for the fast review. Merged to master.

Attachment 274941 [details] pushed as 99b6761 - gaction: Minor clarifications in the GAction documentation