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 760716 - Fix documentation regarding <glib/gprintf.h>
Fix documentation regarding <glib/gprintf.h>
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
unspecified
Other Linux
: Normal enhancement
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2016-01-16 15:06 UTC by Martin Blanchard
Modified: 2017-10-05 14:03 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Fix outdated documentation (1.12 KB, patch)
2016-01-16 15:08 UTC, Martin Blanchard 		committed Details | Review
Add a reminder in each function's documentation abstract (2.96 KB, patch)
2016-01-16 15:19 UTC, Martin Blanchard 		committed Details | Review

Description Martin Blanchard 2016-01-16 15:06:29 UTC 
The 'String Utility Functions' documentation section is outdated regarding functions defined in <glib/gprintf.h>: g_snprintf() and g_vsnprintf() are not declared in gprintf.h anymore but g_vasprintf() is...
Comment 1 Martin Blanchard 2016-01-16 15:08:37 UTC 
Created attachment 319180 [details] [review]
Fix outdated documentation
Comment 2 Martin Blanchard 2016-01-16 15:19:06 UTC 
Created attachment 319181 [details] [review]
Add a reminder in each function's documentation abstract

Adding an reminder in function's documentation abstract probably is a good idea as these abstracts are lost in the middle of the 'String Utility Functions' documentation section.
Comment 3 Philip Withnall 2017-10-05 14:00:41 UTC 
Review of attachment 319180 [details] [review]:

That looks good, thanks.
Comment 4 Philip Withnall 2017-10-05 14:01:15 UTC 
Review of attachment 319181 [details] [review]:

::: glib/gprintf.c
@@ +40,3 @@
  *
+ * Remember to explicitly include `<glib/gprintf.h>` in order to use this
+ * funcion.

s/funcion/function/ (typo)

(and the same in the other additions).
Comment 5 Philip Withnall 2017-10-05 14:03:24 UTC 
I pushed the patches with some minor changes to the second one to fix the typo and make the additions a little shorter. Thanks for the patches.