docs: update comment for hideFromUser #202730
Conversation
|
@microsoft-github-policy-service agree |
| @@ -565,7 +565,7 @@ export interface IShellLaunchConfig { | |||
| * until `Terminal.show` is called. The typical usage for this is when you need to run | |||
| * something that may need interactivity but only want to tell the user about it when | |||
| * interaction is needed. Note that the terminals will still be exposed to all extensions | |||
| * as normal. | |||
| * as normal. And the hidden terminals won't be restored when the workspace is next opened. | |||
There was a problem hiding this comment.
I don't really like starting a sentence with "And"
There was a problem hiding this comment.
Oh same, I guess I didn't save that file when committing as it's meant to be the same
There was a problem hiding this comment.
Sorry about that. I don't know this at all.
| @@ -11737,7 +11737,7 @@ declare module 'vscode' { | |||
| * until `Terminal.show` is called. The typical usage for this is when you need to run | |||
| * something that may need interactivity but only want to tell the user about it when | |||
| * interaction is needed. Note that the terminals will still be exposed to all extensions | |||
| * as normal. And the hidden terminals won't be restored when the workspace is next opened. | |||
| * as normal and they will remain hidden when the workspace is reloaded. | |||
There was a problem hiding this comment.
@Tyriar Sorry for the late comment.
Honestly, I don't think your changes have the same meaning as mine. These hidden terminals will not be restored at all, rather being restored and remain hidden. When I had 2 terminals opened, 1 hidden and 1 not, there would be only 1 terminal opened when the workspace is reloaded.
I used vscode.window.terminals.length to verify it, which is exactly why I want to add this comment, telling developers these hidden terminals that cannot be closed manually by users won't be restored, no need to worry about that there would be tons of hidden terminal when the workspace is reloaded.
I'm not sure if I expressed it correctly. Looking forward for your reply. Thanks.
There was a problem hiding this comment.
Thanks a bunch for following up and sorry about the delayed response 😅
I brought back your correct description in #207016
When creating a terminal with the
hideFromUser: trueoption, I have concerns about the possibility of the hidden terminals being restored upon the next opening of the workspace.To verify this, I tested using
vscode.window.terminals.lengthand confirmed that it won't happen.Considering this, I think it might be beneficial to clarify this point in the comment. So I add
And the hidden terminals won't be restored when the workspace is next opened.to the end of the comment ofhideFromUser