summaryrefslogtreecommitdiff
path: root/redo/uitask.go
diff options
context:
space:
mode:
Diffstat (limited to 'redo/uitask.go')
-rw-r--r--redo/uitask.go6
1 files changed, 4 insertions, 2 deletions
diff --git a/redo/uitask.go b/redo/uitask.go
index 12bd0f3..4460ab2 100644
--- a/redo/uitask.go
+++ b/redo/uitask.go
@@ -8,8 +8,10 @@ import (
"unsafe"
)
-// Go initializes package ui.
-// TODO write this bit
+// Go initializes and runs package ui.
+// It returns a non-nil error if initialization fails.
+// Otherwise, it will run the event loop and not return until Stop is called.
+// Due to platform-specific issues, it must be called from the main OS thread; in general, do not call Go() from anywhere except main() (including any goroutines).
func Go() error {
runtime.LockOSThread()
if err := uiinit(); err != nil {