Merge branch 'str-equal-docs' into 'master'

docs: Amend the docs for g_str_equal() to reflect current general usage

See merge request GNOME/glib!109
This commit is contained in:
Xavier Claessens 2018-06-15 14:53:19 +00:00
commit 75fd0109db

View File

@ -1909,9 +1909,9 @@ g_hash_table_get_values (GHashTable *hash_table)
* @key_equal_func parameter, when using non-%NULL strings as keys in a * @key_equal_func parameter, when using non-%NULL strings as keys in a
* #GHashTable. * #GHashTable.
* *
* Note that this function is primarily meant as a hash table comparison * This function is typically used for hash table comparisons, but can be used
* function. For a general-purpose, %NULL-safe string comparison function, * for general purpose comparisons of non-%NULL strings. For a %NULL-safe string
* see g_strcmp0(). * comparison function, see g_strcmp0().
* *
* Returns: %TRUE if the two keys match * Returns: %TRUE if the two keys match
*/ */