Skip to content

Commit f1c35ba

Browse files
committed
Update docs
1 parent 9654dc4 commit f1c35ba

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

internal/codespaces/codespaces.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ func connectionReady(codespace *api.Codespace) bool {
2323
codespace.Environment.State == api.CodespaceEnvironmentStateAvailable
2424
}
2525

26-
// ConnectToLiveshare creates a Live Share client and joins the Live Share session.
27-
// It will start the Codespace if it is not already running, it will time out after 60 seconds if fails to start.
26+
// ConnectToLiveshare waits for a Codespace to become running,
27+
// and connects to it using a Live Share session.
2828
func ConnectToLiveshare(ctx context.Context, log logger, apiClient *api.API, userLogin, token string, codespace *api.Codespace) (*liveshare.Session, error) {
2929
var startedCodespace bool
3030
if codespace.Environment.State != api.CodespaceEnvironmentStateAvailable {

0 commit comments

Comments
 (0)