📝 Document Task.cancel

This commit is contained in:
Lee Dohm 2017-05-22 16:42:03 -07:00
parent 85e65ffd1c
commit 0842106203
No known key found for this signature in database
GPG Key ID: A27E146D71F5F6B6

View File

@ -155,6 +155,9 @@ class Task
true
# Public: Cancel the running task and emit an event if it was canceled.
#
# Returns a {Boolean} indicating whether the task was terminated.
cancel: ->
didForcefullyTerminate = @terminate()
if didForcefullyTerminate