Update ui.Go() documentation to show that it will return nil when its main() returns now that that behavior is fully implemented.

1 files changed, 3 insertions, 1 deletions

diff --git a/init.go b/init.go
index 56b4571..943d60d 100644
--- a/init.go
+++ b/init.go
@@ -3,7 +3,9 @@ package ui
 
 // Go sets up the UI environment and runs main in a goroutine.
 // If initialization fails, Go returns an error and main is not called.
-// Otherwise, Go does not return to its caller until (unless? TODO) the application loop exits, at which point it returns nil.
+// Otherwise, Go does not return to its caller until main does, at which point it returns nil.
+// After it returns, you cannot call future ui functions/methods meaningfully.
+// (TODO ideally we would want to be able to call ui.MsgBoxError() to report failures to the user, but I would need to figure out how to do this on platforms other than Windows.)
 //
 // This model is undesirable, but Cocoa limitations require it.
 func Go(main func()) error {