From a0d2fe2c32c0d05ecb3e2be19d78b3bf39441fe8 Mon Sep 17 00:00:00 2001
From: Michael Hanselmann <hansmi@google.com>
Date: Fri, 17 Sep 2010 15:54:17 +0200
Subject: [PATCH] jqueue: Add missing docstring to _QueuedJob.Cancel
This was forgotten in commit 099b2870b.
Signed-off-by: Michael Hanselmann <hansmi@google.com>
Reviewed-by: Iustin Pop <iustin@google.com>
---
lib/jqueue.py | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/lib/jqueue.py b/lib/jqueue.py
index 2927b2a37..5a352914a 100644
--- a/lib/jqueue.py
+++ b/lib/jqueue.py
@@ -411,6 +411,13 @@ class _QueuedJob(object):
not_marked = False
def Cancel(self):
+ """Marks job as canceled/-ing if possible.
+
+ @rtype: tuple; (bool, string)
+ @return: Boolean describing whether job was successfully canceled or marked
+ as canceling and a text message
+
+ """
status = self.CalcStatus()
if status not in (constants.JOB_STATUS_QUEUED,
--
GitLab