From d845cc24ff6bd2ed52a78caf89181881330d4281 Mon Sep 17 00:00:00 2001 From: Josh Rickmar Date: Mon, 10 Jun 2024 20:37:38 +0000 Subject: [PATCH] comments --- mixing/mixclient/client.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/mixing/mixclient/client.go b/mixing/mixclient/client.go index b47150c28..a9ce4a9e5 100644 --- 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: