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

Update g_source_remove doc comment: the function doesn't always return TRUE

Browse Source 
This comment was added in a919be3d in 2013. The function basically looked the same
as now at that point. g_main_context_find_source_by_id() can clearly return NULL if
the source id is invalid, so unclear where this comes from? The function in
question are approximately the same since e2fd4e2b in 2000.

However back then g_main_context_find_source_by_id() would actually always return
the last source if there was none with the given source id (wat, that's clearly
unintended?). This was changed in 393503ba in 2014, arguably an API change of that
function but more arguably a bugfix :)

So for a short time between 2013 and 2014, that comment was correct. Now it is not
anymore and can be removed.
This commit is contained in:
Guillaume Gomez 2021-10-10 12:45:05 +00:00 committed by Guillaume Gomez
parent 4023c9b567
commit a3ac24c20d
1 changed files with 0 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
glib/gmain.c
View File

@ -2526,8 +2526,6 @@ g_main_context_find_source_by_user_data (GMainContext *context,
* is called on its (now invalid) source ID. This source ID may have
* been reissued, leading to the operation being performed against the
* wrong source.
*
* Returns: For historical reasons, this function always returns %TRUE
**/
gboolean
g_source_remove (guint tag)