From b6a5e927e0b23bc5538af503d1cfa49a8d2f84ee Mon Sep 17 00:00:00 2001 From: Sam Saccone Date: Sun, 7 Jun 2015 15:32:54 -0400 Subject: [PATCH] :memo: Fix english errors and language --- docs/api/dialog.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 4f4403db6d8e..05b8650a0198 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -1,7 +1,7 @@ # dialog The `dialog` module provides APIs to show native system dialogs, so web -applications can get the same user experience with native applications. +applications can deliver the same user experience as native applications. An example of showing a dialog to select multiple files and directories: @@ -11,7 +11,7 @@ var dialog = require('dialog'); console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); ``` -**Note for OS X**: If you want to present dialogs as sheets, the only thing you have to do is to provide a `BrowserWindow` reference in the `browserWindow` parameter. +**Note for OS X**: If you want to present dialogs as sheets, the only thing you have to do is provide a `BrowserWindow` reference in the `browserWindow` parameter. ## dialog.showOpenDialog([browserWindow], [options], [callback]) @@ -44,10 +44,9 @@ selected, an example is: If a `callback` is passed, the API call would be asynchronous and the result would be passed via `callback(filenames)` -**Note:** On Windows and Linux, an open dialog could not be both file selector -and directory selector at the same time, so if you set `properties` to -`['openFile', 'openDirectory']` on these platforms, a directory selector would -be showed. +**Note:** On Windows and Linux, an open dialog can not be both a file selector +and a directory selector, so if you set `properties` to +`['openFile', 'openDirectory']` on these platforms, a directory selector will be shown. ## dialog.showSaveDialog([browserWindow], [options], [callback]) @@ -58,14 +57,14 @@ be showed. * `filters` Array * `callback` Function -On success, returns the path of file chosen by the user, otherwise returns +On success, returns the path of the file chosen by the user, otherwise returns `undefined`. The `filters` specifies an array of file types that can be displayed, see `dialog.showOpenDialog` for an example. -If a `callback` is passed, the API call would be asynchronous and the result -would be passed via `callback(filename)` +If a `callback` is passed, the API call will be asynchronous and the result +will be passed via `callback(filename)` ## dialog.showMessageBox([browserWindow], options, [callback]) @@ -82,8 +81,8 @@ would be passed via `callback(filename)` Shows a message box, it will block until the message box is closed. It returns the index of the clicked button. -If a `callback` is passed, the API call would be asynchronous and the result -would be passed via `callback(response)` +If a `callback` is passed, the API call will be asynchronous and the result +will be passed via `callback(response)` ## dialog.showErrorBox(title, content)