diff --git a/docs/api/app.md b/docs/api/app.md index 07b26f2c5663..42a5dfc24249 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -152,7 +152,7 @@ Emitted when the gpu process crashes. The `app` object has the following methods: -**Note** Some methods are only available on specific operating systems and are labeled as such. +**Note:** Some methods are only available on specific operating systems and are labeled as such. ### `app.quit()` diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index e9d2c7f6feb8..53a9487733b7 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -117,7 +117,7 @@ Properties `width` and `height` are required. The `BrowserWindow` object emits the following events: -+**Note** Some events are only available on specific operating systems and are labeled as such. ++**Note:** Some events are only available on specific operating systems and are labeled as such. ### Event: 'page-title-updated' @@ -292,7 +292,7 @@ Remove the devtools extension whose name is `name`. Objects created with `new BrowserWindow` have the following instance methods: -+**Note** Some methods are only available on specific operating systems and are labeled as such. ++**Note:** Some methods are only available on specific operating systems and are labeled as such. ```javascript var BrowserWindow = require('browser-window'); diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index f9ca654cf50a..adba06e1adcf 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -4,7 +4,7 @@ The `global-shortcut` module can register/unregister a global keyboard shortcut with the operating system so that you can customize the operations for various shortcuts. -**Note**: The shortcut is global; it will work even if the app does +**Note:** The shortcut is global; it will work even if the app does not have the keyboard focus. You should not use this module until the `ready` event of the app module is emitted. diff --git a/docs/api/ipc-renderer.md b/docs/api/ipc-renderer.md index 3adb0bc95476..752af2ebe293 100644 --- a/docs/api/ipc-renderer.md +++ b/docs/api/ipc-renderer.md @@ -4,7 +4,7 @@ The `ipc` module provides a few methods so you can send synchronous and asynchronous messages from the render process (web page) to the main process. You can also receive replies from the main process. -**Note**: If you want to make use of modules in the main process from the renderer +**Note:** If you want to make use of modules in the main process from the renderer process, you might consider using the [remote](remote.md) module. See [ipc (main process)](ipc-main-process.md) for code examples. @@ -13,7 +13,7 @@ See [ipc (main process)](ipc-main-process.md) for code examples. The `ipc` module has the following methods for sending messages: -**Note**: When using these methods to send a `message` you must also listen +**Note:** When using these methods to send a `message` you must also listen for it in the main process with [`ipc (main process)`](ipc-main-process.md). ### `ipc.send(channel[, arg1][, arg2][, ...])` diff --git a/docs/api/native-image.md b/docs/api/native-image.md index c00ec3a9458a..df2bb96ff9da 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -74,7 +74,7 @@ mixed with other content to create the desired final appearance. The most common case is to use template images for a menu bar icon so it can adapt to both light and dark menu bars. -**Note**: Template image is only supported on OS X. +**Note:** Template image is only supported on OS X. To mark an image as a template image, its filename should end with the word `Template`. For example: diff --git a/docs/api/remote.md b/docs/api/remote.md index ccb16b4b3cc3..5a048fc0789f 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -20,7 +20,7 @@ var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl('https://github.com'); ``` -**Note**: for the reverse (access the renderer process from the main process), +**Note:** for the reverse (access the renderer process from the main process), you can use [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code). ## Remote Objects diff --git a/docs/api/screen.md b/docs/api/screen.md index c22530ca8d0a..934e3eaf5a70 100644 --- a/docs/api/screen.md +++ b/docs/api/screen.md @@ -6,7 +6,7 @@ position, etc. You should not use this module until the `ready` event of the `screen` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). -**Note**: In the renderer / DevTools, `window.screen` is a reserved +**Note:** In the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `var screen = require('screen')` will not work. In our examples below, we use `atomScreen` as the variable name instead. diff --git a/docs/api/tray.md b/docs/api/tray.md index a673307804a7..528705acb325 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -123,7 +123,7 @@ Emitted when dragged files are dropped in the tray icon. The `Tray` module has the following methods: -**Note**: Some methods are only available on specific operating systems and are +**Note:** Some methods are only available on specific operating systems and are labeled as such. ### `Tray.destroy()` diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 6b64a0269c52..1d49a3db130c 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -135,7 +135,7 @@ If "on", the guest page will have web security disabled. The `webview` tag has the following methods: -**Note**: The webview element must be loaded before using the methods. +**Note:** The webview element must be loaded before using the methods. **Example** ```javascript