luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-14 05:16:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

goption: Clarify expected format of option group description in docs

Browse Source 
To match the current widespread usage.

We can’t automatically append a colon to the group description, as that
would interact badly with translation of the string.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Fixes: #3007
This commit is contained in:
Philip Withnall 2023-06-28 17:03:00 +01:00
parent e8f14a66a6
commit 98f9a11390
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
glib/goption.c
View File

@ -2297,6 +2297,11 @@ g_option_context_parse (GOptionContext *context,
* *
* Creates a new #GOptionGroup. * Creates a new #GOptionGroup.
* *
* @description is typically used to provide a title for the group. If so, it
* is recommended that it’s written in title case, and has a trailing colon so
* that it matches the style of built-in GLib group titles such as
* ‘Application Options:’.
*
* Returns: a newly created option group. It should be added * Returns: a newly created option group. It should be added
* to a #GOptionContext or freed with g_option_group_unref(). * to a #GOptionContext or freed with g_option_group_unref().
* *