Skip to content

Commit 271cd1a

Browse files
committed
Clarify exitcode docs
1 parent c976bb3 commit 271cd1a

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

exec.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ type Process interface {
3030
Stderr() io.Reader
3131
// Resize resizes the TTY if a TTY is enabled.
3232
Resize(ctx context.Context, rows, cols uint16) error
33-
// Wait returns ExitError when the command terminates.
33+
// Wait returns ExitError when the command terminates with a non-zero exit code.
3434
Wait() error
3535
// Close terminates the process and underlying connection(s).
3636
// It must be called otherwise a connection or process may leak.

internal/proto/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ and a body follows after a newline character.
7979
This is the last message sent by the server.
8080

8181
```json
82-
{ "type": "exit_code", "code": 255 }
82+
{ "type": "exit_code", "exit_code": 255 }
8383
```
8484

8585
A normal closure follows.

0 commit comments

Comments
 (0)