Merge branch 'unix-fd-source-docs' into 'main'

glib-unix: Improve documentation for g_unix_fd_source_new()

See merge request GNOME/glib!3396

1 files changed, 6 insertions, 3 deletions

diff --git a/glib/glib-unix.c b/glib/glib-unix.c
index ef0d1fbfb..f671887c9 100644
--- a/glib/glib-unix.c
+++ b/glib/glib-unix.c
@@ -293,12 +293,15 @@ GSourceFuncs g_unix_fd_source_funcs = {
 /**
  * g_unix_fd_source_new:
  * @fd: a file descriptor
- * @condition: IO conditions to watch for on @fd
+ * @condition: I/O conditions to watch for on @fd
  *
- * Creates a #GSource to watch for a particular IO condition on a file
+ * Creates a #GSource to watch for a particular I/O condition on a file
  * descriptor.
  *
- * The source will never close the fd -- you must do it yourself.
+ * The source will never close the @fd — you must do it yourself.
+ *
+ * Any callback attached to the returned #GSource must have type
+ * #GUnixFDSourceFunc.
  *
  * Returns: the newly created #GSource
  *