Remove incorrect statement about closing on Attach

code-asher · code-asher · commit 0150f51ca0e4 · 2023-08-09T10:48:08.000-08:00
In some cases it might get closed but it is not a guarantee like the
comment claims it is.

While we could implement this behavior properly we already close the
connection in the caller so it seems unnecessary.
diff --git a/agent/reconnectingpty/reconnectingpty.go b/agent/reconnectingpty/reconnectingpty.go
@@ -44,7 +44,7 @@ type ReconnectingPTY interface {
 	// history, then blocks until EOF, an error, or the context's end.  The
 	// connection is expected to send JSON-encoded messages and accept raw output
 	// from the ptty.  If the context ends or the process dies the connection will
-	// be detached and closed.
+	// be detached.
 	Attach(ctx context.Context, connID string, conn net.Conn, height, width uint16, logger slog.Logger) error
 	// Wait waits for the reconnecting pty to close.  The underlying process might
 	// still be exiting.
