From bb1f765df365770a0ce48642e69f7b3a41654e1b Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 12 Nov 2018 08:07:52 -0500 Subject: [PATCH] Clarify docs for g_settings_list_children The docs sound like settings list is a thing, and a ::children-changed signal exists. That is not the case, and will never be the case at this point, so stop pretending. Closes: #1362 --- gio/gsettings.c | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/gio/gsettings.c b/gio/gsettings.c index ab7f43835..4f5a38cdd 100644 --- a/gio/gsettings.c +++ b/gio/gsettings.c @@ -2469,16 +2469,9 @@ g_settings_list_keys (GSettings *settings) * The list is exactly the list of strings for which it is not an error * to call g_settings_get_child(). * - * For GSettings objects that are lists, this value can change at any - * time. Note that there is a race condition here: you may - * request a child after listing it only for it to have been destroyed - * in the meantime. For this reason, g_settings_get_child() may return - * %NULL even for a child that was listed by this function. - * - * For GSettings objects that are not lists, you should probably not be - * calling this function from "normal" code (since you should already - * know what children are in your schema). This function may still be - * useful there for introspection reasons, however. + * There is little reason to call this function from "normal" code, since + * you should already know what children are in your schema. This function + * may still be useful there for introspection reasons, however. * * You should free the return value with g_strfreev() when you are done * with it.