From 08421062034b0a7ad3589f003674f961b1d410f6 Mon Sep 17 00:00:00 2001
From: Lee Dohm <lee@lee-dohm.com>
Date: Mon, 22 May 2017 16:42:03 -0700
Subject: [PATCH] :memo: Document Task.cancel

---
 src/task.coffee | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/task.coffee b/src/task.coffee
index b8283cb01..fa09c69f1 100644
--- a/src/task.coffee
+++ b/src/task.coffee
@@ -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