From 0b245b96e4c42ef90f98809ede7e4deaf942f3c2 Mon Sep 17 00:00:00 2001 From: Stephen Niedzielski Date: Thu, 26 Nov 2015 22:35:22 -0700 Subject: [PATCH] Update docs for globalShortcut.register Document return value for globalShortcut.register and common failure scenario. Fix: #3600 --- docs/api/global-shortcut.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index a0f069d7f1c5..ab6123bd877e 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -46,7 +46,10 @@ The `global-shortcut` module has the following methods: * `callback` Function Registers a global shortcut of `accelerator`. The `callback` is called when -the registered shortcut is pressed by the user. +the registered shortcut is pressed by the user. Returns `true` if the shortcut +`accelerator` was registered, `false` otherwise. For example, the specified +`accelerator` has already been registered by another caller or other native +applications. ### `globalShortcut.isRegistered(accelerator)`