[glib: 2/3] gerror: Clarify reference to g_key_file_has_key() in documentation




commit ea6fe7194a4e7681b9aaf91231228ed06b178d76
Author: Philip Withnall <pwithnall endlessos org>
Date:   Mon Jan 4 16:44:12 2021 +0000

    gerror: Clarify reference to g_key_file_has_key() in documentation
    
    It’s not actually deprecated, but it is hard to use. It was briefly
    deprecated, but then the deprecation was reversed before a stable
    release.
    
    See https://bugzilla.gnome.org/show_bug.cgi?id=650345.
    
    Reported on StackOverflow as
    https://stackoverflow.com/q/65505393/2931197.
    
    Signed-off-by: Philip Withnall <pwithnall endlessos org>

 glib/gerror.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
---
diff --git a/glib/gerror.c b/glib/gerror.c
index dc24b8f5b..e554df884 100644
--- a/glib/gerror.c
+++ b/glib/gerror.c
@@ -354,7 +354,7 @@
  *   #GError is set.  Among other problems, it requires C callers to allocate
  *   a temporary error.  Instead, provide a `gboolean *` out parameter.
  *   There are functions in GLib itself such as g_key_file_has_key() that
- *   are deprecated because of this. If %FALSE is returned, the error must
+ *   are hard to use because of this. If %FALSE is returned, the error must
  *   be set to a non-%NULL value.  One exception to this is that in situations
  *   that are already considered to be undefined behaviour (such as when a
  *   g_return_val_if_fail() check fails), the error need not be set.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]