Browse Source

docs: note that shell can't be used in sandboxed renderers (#22974)

Jeremy Apthorp 5 years ago
parent
commit
6bf83e9244
1 changed files with 3 additions and 1 deletions
  1. 3 1
      docs/api/shell.md

+ 3 - 1
docs/api/shell.md

@@ -2,7 +2,7 @@
 
 > Manage files and URLs using their default applications.
 
-Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
+Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process) (non-sandboxed only)
 
 The `shell` module provides functions related to desktop integration.
 
@@ -14,6 +14,8 @@ const { shell } = require('electron')
 shell.openExternal('https://github.com')
 ```
 
+**Note:** While the `shell` module can be used in the renderer process, it will not function in a sandboxed renderer.
+
 ## Methods
 
 The `shell` module has the following methods: