Skip to content

Commit 131ee0e

Browse files
authored
Merge pull request microsoft#236736 from microsoft/tyriar/236670
Explain exitCode undefined in more detail
2 parents dfdece6 + 437450a commit 131ee0e

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

src/vscode-dts/vscode.d.ts

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7724,10 +7724,17 @@ declare module 'vscode' {
77247724
/**
77257725
* The exit code reported by the shell.
77267726
*
7727-
* Note that `undefined` means the shell either did not report an exit code (ie. the shell
7728-
* integration script is misbehaving) or the shell reported a command started before the command
7729-
* finished (eg. a sub-shell was opened). Generally this should not happen, depending on the use
7730-
* case, it may be best to treat this as a failure.
7727+
* When this is `undefined` it can mean several things:
7728+
*
7729+
* - The shell either did not report an exit code (ie. the shell integration script is
7730+
* misbehaving)
7731+
* - The shell reported a command started before the command finished (eg. a sub-shell was
7732+
* opened).
7733+
* - The user canceled the command via ctrl+c.
7734+
* - The user pressed enter when there was no input.
7735+
*
7736+
* Generally this should not happen. Depending on the use case, it may be best to treat this
7737+
* as a failure.
77317738
*
77327739
* @example
77337740
* const execution = shellIntegration.executeCommand({

0 commit comments

Comments
 (0)