comments

jrick · Jun 10, 2024 · d845cc2 · d845cc2
1 parent d59657d
commit d845cc2
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/mixing/mixclient/client.go b/mixing/mixclient/client.go
@@ -733,9 +733,10 @@ func (c *Client) handleSubmitQueue(ctx context.Context) error {
 	}
 }
 
-// Ready returns whether the client has completed the initial message
+// Ready returns nil when the client has completed the initial message
 // observing period and is ready to submit new pair requests and interact in
-// mix sessions.
+// mix sessions.  If the client is still in the warmup phase, this returns
+// ErrWarming.
 func (c *Client) Ready() error {
 	select {
 	case <-c.warming: