Merge pull request #6649 from miniak/docs-fix

docs: fix argument types
This commit is contained in:
Cheng Zhao 2016-07-29 22:51:26 +09:00 committed by GitHub
commit 67ef47104f
2 changed files with 5 additions and 2 deletions

View file

@ -627,7 +627,7 @@ Returns a boolean, whether the window is in fullscreen mode.
#### `win.setAspectRatio(aspectRatio[, extraSize])` _macOS_ #### `win.setAspectRatio(aspectRatio[, extraSize])` _macOS_
* `aspectRatio` The aspect ratio to maintain for some portion of the * `aspectRatio` Float - The aspect ratio to maintain for some portion of the
content view. content view.
* `extraSize` Object (optional) - The extra size not to be included while * `extraSize` Object (optional) - The extra size not to be included while
maintaining the aspect ratio. maintaining the aspect ratio.
@ -820,6 +820,9 @@ window.
#### `win.setSheetOffset(offsetY[, offsetX])` _macOS_ #### `win.setSheetOffset(offsetY[, offsetX])` _macOS_
* `offsetY` Float
* `offsetX` Float (optional)
Changes the attachment point for sheets on macOS. By default, sheets are Changes the attachment point for sheets on macOS. By default, sheets are
attached just below the window frame, but you may want to display them beneath attached just below the window frame, but you may want to display them beneath
a HTML-rendered toolbar. For example: a HTML-rendered toolbar. For example:

View file

@ -918,7 +918,7 @@ app.on('ready', () => {
(screenPosition == mobile) (default: `{x: 0, y: 0}`) (screenPosition == mobile) (default: `{x: 0, y: 0}`)
* `x` Integer - Set the x axis offset from top left corner * `x` Integer - Set the x axis offset from top left corner
* `y` Integer - Set the y axis offset from top left corner * `y` Integer - Set the y axis offset from top left corner
* `deviceScaleFactor` Integer - Set the device scale factor (if zero defaults to * `deviceScaleFactor` Float - Set the device scale factor (if zero defaults to
original device scale factor) (default: `0`) original device scale factor) (default: `0`)
* `viewSize` Object - Set the emulated view size (empty means no override) * `viewSize` Object - Set the emulated view size (empty means no override)
* `width` Integer - Set the emulated view width * `width` Integer - Set the emulated view width