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 791318 - GBytes: Improve documentation
GBytes: Improve documentation
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
unspecified
Other All
: Normal minor
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2017-12-06 19:50 UTC by Umang Jain
Modified: 2017-12-07 10:31 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
GBytes: Improve documentation (721 bytes, patch)
2017-12-06 19:50 UTC, Umang Jain
needs-work Details | Review
gbytes: Clarify nullability for g_bytes_unref () in docs (731 bytes, patch)
2017-12-07 10:22 UTC, Umang Jain
committed Details | Review

Description Umang Jain 2017-12-06 19:50:17 UTC
Created attachment 365148 [details] [review]
GBytes: Improve documentation

Improve documentation
Comment 1 Philip Withnall 2017-12-07 10:07:04 UTC
Review of attachment 365148 [details] [review]:

The commit message could be more descriptive: how is the documentation being improved? I suggest something like: “gbytes: Clarify nullability for g_bytes_unref() in docs”

::: glib/gbytes.c
@@ +296,3 @@
  * Releases a reference on @bytes.  This may result in the bytes being
+ * freed. If bytes is NULL it simply returns, so there is no need to check
+ * against NULL before calling this function.

There’s no need to make the same point twice here. You could simplify the addition to “If @bytes is %NULL, it will return immediately.”.
Comment 2 Umang Jain 2017-12-07 10:22:01 UTC
Created attachment 365182 [details] [review]
gbytes: Clarify nullability for g_bytes_unref () in docs
Comment 3 Philip Withnall 2017-12-07 10:31:45 UTC
Thanks. I tweaked the patch slightly before pushing, to add some missing gtk-doc syntax which got lost between my suggestion and the uploaded patch.