Skip to content

Commit 8f7aec2

Browse files
authored
Update JSDoc on updateWorkspaceFolders when extension host will restart (fix microsoft#165010) (microsoft#165813)
1 parent 07a5351 commit 8f7aec2

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/vscode-dts/vscode.d.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11990,9 +11990,11 @@ declare module 'vscode' {
1199011990
* by an optional set of `workspaceFoldersToAdd` on the `vscode.workspace.workspaceFolders` array. This "splice"
1199111991
* behavior can be used to add, remove and change workspace folders in a single operation.
1199211992
*
11993-
* If the first workspace folder is added, removed or changed, the currently executing extensions (including the
11994-
* one that called this method) will be terminated and restarted so that the (deprecated) `rootPath` property is
11995-
* updated to point to the first workspace folder.
11993+
* **Note:** in some cases calling this method may result in the currently executing extensions (including the
11994+
* one that called this method) to be terminated and restarted. For example when the first workspace folder is
11995+
* added, removed or changed the (deprecated) `rootPath` property is updated to point to the first workspace
11996+
* folder. Another case is when transitioning from an empty or single-folder workspace into a multi-folder
11997+
* workspace (see also: https://code.visualstudio.com/docs/editor/workspaces).
1199611998
*
1199711999
* Use the {@linkcode onDidChangeWorkspaceFolders onDidChangeWorkspaceFolders()} event to get notified when the
1199812000
* workspace folders have been updated.

0 commit comments

Comments
 (0)