github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-04-28 03:01:47 -04:00
Code Issues Packages Projects Releases Wiki Activity

improve confirm documentation

Browse Source
This commit is contained in:
Tony Brix
2017-05-26 14:12:05 -05:00
committed by GitHub
parent c78ffa2e82
commit f16cbfbfa1
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/atom-environment.coffee
View File

@@ -821,6 +821,9 @@ class AtomEnvironment extends Model
@emitter.emit 'did-beep' @emitter.emit 'did-beep'
# Essential: A flexible way to open a dialog akin to an alert dialog. # Essential: A flexible way to open a dialog akin to an alert dialog.
#
# If the dialog is closed (via `Esc` key or `X` in the top corner) without selecting a button
# the first button will be clicked unless a "Cancel" or "No" button is provided.
# #
# ## Examples # ## Examples
# #
@@ -839,7 +842,7 @@ class AtomEnvironment extends Model
# * `buttons` (optional) Either an array of strings or an object where keys are # * `buttons` (optional) Either an array of strings or an object where keys are
# button names and the values are callbacks to invoke when clicked. # button names and the values are callbacks to invoke when clicked.
# #
# Returns the chosen button index {Number} if the buttons option was an array. # Returns the chosen button index {Number} if the buttons option is an array or the return value of the callback if the buttons option is an object.
confirm: (params={}) -> confirm: (params={}) ->
@applicationDelegate.confirm(params) @applicationDelegate.confirm(params)