Clarify "current condition" in g_socket_create_source docs
authorAlexander Larsson <alexl@redhat.com>
Wed, 20 May 2009 09:30:43 +0000 (11:30 +0200)
committerAlexander Larsson <alexl@redhat.com>
Wed, 20 May 2009 09:30:43 +0000 (11:30 +0200)
gio/gsocket.c

index 1201be7..e5e6fe8 100644 (file)
@@ -2308,8 +2308,10 @@ winsock_source_new (GSocket      *socket,
  * these conditions will always be reported output if they are true.
  *
  * @cancellable if not %NULL can be used to cancel the source, which will
- * cause the source to trigger, reporting the current condition. You can
- * check for this in the callback using g_cancellable_is_cancelled().
+ * cause the source to trigger, reporting the current condition (which
+ * is likely 0 unless cancellation happened at the same time as a
+ * condition change). You can check for this in the callback using
+ * g_cancellable_is_cancelled().
  *
  * Returns: a newly allocated %GSource, free with g_source_unref().
  *