mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-08-01 23:13:40 +02:00
goption: Clarify expected format of option group description in docs
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:
@@ -2297,6 +2297,11 @@ g_option_context_parse (GOptionContext *context,
|
||||
*
|
||||
* 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
|
||||
* to a #GOptionContext or freed with g_option_group_unref().
|
||||
*
|
||||
|
Reference in New Issue
Block a user