mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: fix doc linter warnings (#17818)

Browse source
This commit is contained in:
Samuel Attard 2019-04-16 19:03:17 -04:00 committed by GitHub
parent 33fd20047c
commit f901170a4f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api/browser-window.md
View file

@ -1237,7 +1237,7 @@ that stores data of the snapshot. Omitting `rect` will capture the whole visible
* `rect` [Rectangle](structures/rectangle.md) (optional) - The bounds to capture * `rect` [Rectangle](structures/rectangle.md) (optional) - The bounds to capture
* Returns `Promise<NativeImage>` - Resolves with a [NativeImage](native-image.md) Returns `Promise<NativeImage>` - Resolves with a [NativeImage](native-image.md)
Captures a snapshot of the page within `rect`. Omitting `rect` will capture the whole visible page. Captures a snapshot of the page within `rect`. Omitting `rect` will capture the whole visible page.

9
docs/api/process.md
View file

@ -205,9 +205,12 @@ that all statistics are reported in Kilobytes.
Returns `String` - The version of the host operating system. Returns `String` - The version of the host operating system.
Examples: Examples:
- macOS: `10.13.6`
- Windows: `10.0.17763` | Platform | Version |
- Linux: `4.15.0-45-generic` |----------|---------|
| macOS | `10.13.6` |
| Windows | `10.0.17763` |
| Linux | `4.15.0-45-generic` |
**Note:** It returns the actual operating system version instead of kernel version on macOS unlike `os.release()`. **Note:** It returns the actual operating system version instead of kernel version on macOS unlike `os.release()`.

4
docs/api/web-contents.md
View file

@ -1185,7 +1185,7 @@ that stores data of the snapshot. Omitting `rect` will capture the whole visible
* `rect` [Rectangle](structures/rectangle.md) (optional) - The area of the page to be captured. * `rect` [Rectangle](structures/rectangle.md) (optional) - The area of the page to be captured.
* Returns `Promise<NativeImage>` - Resolves with a [NativeImage](native-image.md) Returns `Promise<NativeImage>` - Resolves with a [NativeImage](native-image.md)
Captures a snapshot of the page within `rect`. Omitting `rect` will capture the whole visible page. Captures a snapshot of the page within `rect`. Omitting `rect` will capture the whole visible page.
@ -1249,7 +1249,7 @@ The `callback` will be called with `callback(error, data)` on completion. The
* `printSelectionOnly` Boolean (optional) - Whether to print selection only. * `printSelectionOnly` Boolean (optional) - Whether to print selection only.
* `landscape` Boolean (optional) - `true` for landscape, `false` for portrait. * `landscape` Boolean (optional) - `true` for landscape, `false` for portrait.
* Returns `Promise<Buffer>` - Resolves with the generated PDF data. Returns `Promise<Buffer>` - Resolves with the generated PDF data.
Prints window's web page as PDF with Chromium's preview printing custom Prints window's web page as PDF with Chromium's preview printing custom
settings. settings.

4
docs/api/webview-tag.md
View file

@ -580,7 +580,7 @@ Prints `webview`'s web page as PDF, Same as `webContents.printToPDF(options, cal
* `printSelectionOnly` Boolean (optional) - Whether to print selection only. * `printSelectionOnly` Boolean (optional) - Whether to print selection only.
* `landscape` Boolean (optional) - `true` for landscape, `false` for portrait. * `landscape` Boolean (optional) - `true` for landscape, `false` for portrait.
* Returns `Promise<Buffer>` - Resolves with the generated PDF data. Returns `Promise<Buffer>` - Resolves with the generated PDF data.
Prints `webview`'s web page as PDF, Same as `webContents.printToPDF(options)`. Prints `webview`'s web page as PDF, Same as `webContents.printToPDF(options)`.
@ -600,7 +600,7 @@ that stores data of the snapshot. Omitting `rect` will capture the whole visible
* `rect` [Rectangle](structures/rectangle.md) (optional) - The area of the page to be captured. * `rect` [Rectangle](structures/rectangle.md) (optional) - The area of the page to be captured.
* Returns `Promise<NativeImage>` - Resolves with a [NativeImage](native-image.md) Returns `Promise<NativeImage>` - Resolves with a [NativeImage](native-image.md)
Captures a snapshot of the page within `rect`. Omitting `rect` will capture the whole visible page. Captures a snapshot of the page within `rect`. Omitting `rect` will capture the whole visible page.