From 67332790375e0ed457f4517720355c9ec566de8f Mon Sep 17 00:00:00 2001 From: Darshan Sen Date: Mon, 18 Apr 2022 19:41:44 +0530 Subject: [PATCH] docs: document when BrowserWindow and BrowserView can be used (#33696) We already document such info for other APIs, like the 'screen' API in https://github.com/electron/electron/blob/f711fe6b5701196e5d803c04aab44bc62b392f8e/docs/api/screen.md?plain=1#L7-L8. So we should do the same thing for these ones too. Signed-off-by: Darshan Sen --- docs/api/browser-view.md | 3 +++ docs/api/browser-window.md | 3 +++ 2 files changed, 6 insertions(+) diff --git a/docs/api/browser-view.md b/docs/api/browser-view.md index ed63f4a4881db..a2c5b03079a06 100644 --- a/docs/api/browser-view.md +++ b/docs/api/browser-view.md @@ -11,6 +11,9 @@ relative to its owning window. It is meant to be an alternative to the Process: [Main](../glossary.md#main-process) +This module cannot be used until the `ready` event of the `app` +module is emitted. + ### Example ```javascript diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 44de118440190..4adb22ec0e6ea 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -4,6 +4,9 @@ Process: [Main](../glossary.md#main-process) +This module cannot be used until the `ready` event of the `app` +module is emitted. + ```javascript // In the main process. const { BrowserWindow } = require('electron')