Add notes on what retainContextWhileHidden does to scripts

Fixes #48719
microsoft · Apr 26, 2018 · 8f1f772 · 8f1f772
1 parent 82d97b4
commit 8f1f772
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/src/vs/vscode.d.ts b/src/vs/vscode.d.ts
@@ -5153,9 +5153,11 @@ declare module 'vscode' {
 		 * Normally the webview panel's html context is created when the panel becomes visible
 		 * and destroyed when it is is hidden. Extensions that have complex state
 		 * or UI can set the `retainContextWhenHidden` to make VS Code keep the webview
-		 * context around, even when the webview moves to a background tab. When
-		 * the panel becomes visible again, the context is automatically restored
-		 * in the exact same state it was in originally.
+		 * context around, even when the webview moves to a background tab. When a webview using
+		 * `retainContextWhenHidden` becomes hidden, its scripts and other dynamic content are suspended.
+		 * When the panel becomes visible again, the context is automatically restored
+		 * in the exact same state it was in originally. You cannot send messages to a
+		 * hidden webview, even with `retainContextWhenHidden` enabled.
 		 *
 		 * `retainContextWhenHidden` has a high memory overhead and should only be used if
 		 * your panel's context cannot be quickly saved and restored.