Browse Source

docs: clarify dock.bounce usage (#19907)

trop[bot] 5 years ago
parent
commit
192326c7c5
1 changed files with 3 additions and 1 deletions
  1. 3 1
      docs/api/dock.md

+ 3 - 1
docs/api/dock.md

@@ -18,6 +18,8 @@ app.dock.bounce()
 * `type` String (optional) - Can be `critical` or `informational`. The default is
  `informational`
 
+Returns `Integer` - an ID representing the request.
+
 When `critical` is passed, the dock icon will bounce until either the
 application becomes active or the request is canceled.
 
@@ -25,7 +27,7 @@ When `informational` is passed, the dock icon will bounce for one second.
 However, the request remains active until either the application becomes active
 or the request is canceled.
 
-Returns `Integer` an ID representing the request.
+**Nota Bene:** This method can only be used while the app is not focused; when the app is focused it will return -1.
 
 #### `dock.cancelBounce(id)` _macOS_