Add a note about glib.IdleAddOnce in documentation.

pekim · Dec 30, 2018 · d961df8 · d961df8
1 parent 256761b
commit d961df8
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 3 deletions.
diff --git a/docs-src/content/goroutines.md b/docs-src/content/goroutines.md
@@ -10,6 +10,8 @@ To perform such a call from a goroutine,
 use `glib.IdleAdd` to schedule invocation of a
 callback function on the main thread. 
 
+## `IdleAdd`
+
 ```go
 glib.IdleAdd(func() bool {
     someLabel.SetText("some text")
@@ -21,3 +23,21 @@ Return `glib.SOURCE_REMOVE` to ensure the function is not
 called again next time the main loop is idle.
 Alternatively return `glib.SOURCE_CONTINUE` to have
 the function called again.
+
+## `IdleAddOnce`
+
+Alternatively, `glib.IdleAddOnce`
+schedules a _single_ invocation of a
+callback function on the main thread.
+Unlike `glib.IdleAdd` no value needs to be returned
+to avoid subsequent invocations of the callback.
+
+
+```go
+glib.IdleAddOnce(func() {
+    someLabel.SetText("some text")
+})
+```
+
+`IdleAddOnce` is a convenience provided by gobbi.
+It has no direct equivalent in the glib C library.
diff --git a/docs/goroutines/index.html b/docs/goroutines/index.html
diff --git a/docs/index.json b/docs/index.json
diff --git a/lib/glib/main_event_loop.go b/lib/glib/main_event_loop.go
@@ -52,7 +52,7 @@ sources after one invocation. That is, the callback will only be called once.
 func IdleAddOnce(callback IdleAddOnceCallback) {
 	IdleAdd(func() bool {
 		callback()
-		return false
+		return SOURCE_REMOVE
 	})
 }