diff --git a/docs/api/native-image.md b/docs/api/native-image.md index 4b90fcfce612..c00ec3a9458a 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -19,20 +19,20 @@ var image = clipboard.readImage(); var appIcon = new Tray(image); ``` -## Supported formats +## Supported Formats -Currently `PNG` and `JPEG` are supported. It is recommended to use `PNG` because -of its support for transparency and lossless compression. +Currently `PNG` and `JPEG` image formats are supported. `PNG` is recommended +because of its support for transparency and lossless compression. -On Windows, you can also load `ICO` icon from a file path. +On Windows, you can also load an `ICO` icon from a file path. -## High resolution image +## High Resolution Image On platforms that have high-DPI support, you can append `@2x` after image's base filename to mark it as a high resolution image. For example if `icon.png` is a normal image that has standard resolution, then -`icon@2x.png` would be treated as a high resolution image that has double DPI +`icon@2x.png` will be treated as a high resolution image that has double DPI density. If you want to support displays with different DPI densities at the same time, diff --git a/docs/api/power-save-blocker.md b/docs/api/power-save-blocker.md index 451dde105da8..26f0abc84808 100644 --- a/docs/api/power-save-blocker.md +++ b/docs/api/power-save-blocker.md @@ -1,7 +1,7 @@ # powerSaveBlocker The `power-save-blocker` module is used to block the system from entering -low-power (sleep) mode thus allowing the app to keep the system and screen +low-power (sleep) mode and thus allowing the app to keep the system and screen active. For example: @@ -28,12 +28,12 @@ The `powerSaveBlocker` module has the following methods: * `prevent-display-sleep`- Prevent the display from going to sleep. Keeps system and screen active. Example use case: playing video. -Starts the power save blocker preventing the system from entering lower-power -mode. Returns an integer identifying the power save blocker. +Starts preventing the system from entering lower-power mode. Returns an integer +identifying the power save blocker. **Note:** `prevent-display-sleep` has higher has precedence over `prevent-app-suspension`. Only the highest precedence type takes effect. In -other words, `prevent-display-sleep` always take precedence over +other words, `prevent-display-sleep` always takes precedence over `prevent-app-suspension`. For example, an API calling A requests for `prevent-app-suspension`, and diff --git a/docs/api/process.md b/docs/api/process.md index 15a1cca19f08..120b2853bed5 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -1,4 +1,4 @@ -# Process +# process The `process` object in Electron has the following differences from the one in upstream node: