From f1c35ba9daa06996205082f05a275ce97aa68297 Mon Sep 17 00:00:00 2001 From: Jose Garcia Date: Thu, 23 Sep 2021 10:21:01 -0400 Subject: [PATCH] Update docs --- internal/codespaces/codespaces.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/codespaces/codespaces.go b/internal/codespaces/codespaces.go index 7b27b817e..43809bab9 100644 --- a/internal/codespaces/codespaces.go +++ b/internal/codespaces/codespaces.go @@ -23,8 +23,8 @@ func connectionReady(codespace *api.Codespace) bool { codespace.Environment.State == api.CodespaceEnvironmentStateAvailable } -// ConnectToLiveshare creates a Live Share client and joins the Live Share session. -// It will start the Codespace if it is not already running, it will time out after 60 seconds if fails to start. +// ConnectToLiveshare waits for a Codespace to become running, +// and connects to it using a Live Share session. func ConnectToLiveshare(ctx context.Context, log logger, apiClient *api.API, userLogin, token string, codespace *api.Codespace) (*liveshare.Session, error) { var startedCodespace bool if codespace.Environment.State != api.CodespaceEnvironmentStateAvailable {