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

fix linting errors in docs

Browse source
This commit is contained in:
Zeke Sikelianos 2016-08-22 11:47:55 -07:00
parent ee44ab7ecd
commit 8c0a551d25
4 changed files with 6 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -985,7 +985,7 @@ The `flags` is an array that can include following `String`s:
#### `win.setThumbnailClip(region)` _Windows_ #### `win.setThumbnailClip(region)` _Windows_
* `region` - Object * `region` Object - Region of the window
* `x` Integer - x-position of region * `x` Integer - x-position of region
* `y` Integer - y-position of region * `y` Integer - y-position of region
* `width` Integer - width of region * `width` Integer - width of region

4
docs/api/session.md
View file

@ -20,7 +20,7 @@ const ses = win.webContents.session
The `session` module has the following methods: The `session` module has the following methods:
### session.fromPartition(partition[, options]) ### `session.fromPartition(partition[, options])`
* `partition` String * `partition` String
* `options` Object * `options` Object
@ -43,7 +43,7 @@ of an existing `Session` object.
The `session` module has the following properties: The `session` module has the following properties:
### session.defaultSession ### `session.defaultSession`
Returns the default session object of the app. Returns the default session object of the app.

4
docs/api/system-preferences.md
View file

@ -43,9 +43,7 @@ Removes the subscriber with `id`.
### `systemPreferences.subscribeLocalNotification(event, callback)` _macOS_ ### `systemPreferences.subscribeLocalNotification(event, callback)` _macOS_
Same as `subscribeNotification`, but uses `NSNotificationCenter` for local defaults. Same as `subscribeNotification`, but uses `NSNotificationCenter` for local defaults.
This is necessary for events such as: This is necessary for events such as `NSUserDefaultsDidChangeNotification`
* `NSUserDefaultsDidChangeNotification`
### `systemPreferences.unsubscribeLocalNotification(id)` _macOS_ ### `systemPreferences.unsubscribeLocalNotification(id)` _macOS_

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

@ -850,7 +850,6 @@ Opens the developer tools for the service worker context.
#### `contents.send(channel[, arg1][, arg2][, ...])` #### `contents.send(channel[, arg1][, arg2][, ...])`
* `channel` String * `channel` String
* `arg` (optional)
Send an asynchronous message to renderer process via `channel`, you can also Send an asynchronous message to renderer process via `channel`, you can also
send arbitrary arguments. Arguments will be serialized in JSON internally and send arbitrary arguments. Arguments will be serialized in JSON internally and
@ -893,8 +892,8 @@ app.on('ready', () => {
* `screenPosition` String - Specify the screen type to emulate * `screenPosition` String - Specify the screen type to emulate
(default: `desktop`) (default: `desktop`)
* `desktop` * `desktop` - Desktop screen type
* `mobile` * `mobile` - Mobile screen type
* `screenSize` Object - Set the emulated screen size (screenPosition == mobile) * `screenSize` Object - Set the emulated screen size (screenPosition == mobile)
* `width` Integer - Set the emulated screen width * `width` Integer - Set the emulated screen width
* `height` Integer - Set the emulated screen height * `height` Integer - Set the emulated screen height