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

fix(docs): fix all missing dots and add some links

Browse source
This commit is contained in:
Toinane 2017-11-29 11:38:35 +01:00
parent 59607c9a17
commit 323ea2b27b
No known key found for this signature in database
GPG key ID: 1A3729C1B6D59115
24 changed files with 148 additions and 148 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/api/shell.md
View file

@ -22,7 +22,7 @@ The `shell` module has the following methods:
* `fullPath` String
Returns `Boolean` - Whether the item was successfully shown
Returns `Boolean` - Whether the item was successfully shown.
Show the given file in a file manager. If possible, select the file.
@ -36,11 +36,11 @@ Open the given file in the desktop's default manner.
### `shell.openExternal(url[, options, callback])`
* `url` String - max 2081 characters on windows, or the function returns false
* `url` String - max 2081 characters on windows, or the function returns false.
* `options` Object (optional) _macOS_
* `activate` Boolean - `true` to bring the opened application to the
foreground. The default is `true`.
* `callback` Function (optional) - If specified will perform the open asynchronously. _macOS_
* `callback` Function (optional) _macOS_ - If specified will perform the open asynchronously.
* `error` Error
Returns `Boolean` - Whether an application was available to open the URL.
@ -53,7 +53,7 @@ example, mailto: URLs in the user's default mail agent).
* `fullPath` String
Returns `Boolean` - Whether the item was successfully moved to the trash
Returns `Boolean` - Whether the item was successfully moved to the trash.
Move the given file to trash and returns a boolean status for the operation.
@ -71,7 +71,7 @@ Play the beep sound.
exist.
* `options` [ShortcutDetails](structures/shortcut-details.md)
Returns `Boolean` - Whether the shortcut was created successfully
Returns `Boolean` - Whether the shortcut was created successfully.
Creates or updates a shortcut link at `shortcutPath`.