From 26d134e011d81437fc6be21039dabaf7b6a102c9 Mon Sep 17 00:00:00 2001
From: Celso Providelo <celso.providelo@canonical.com>
Date: Wed, 21 Jan 2015 12:44:20 -0200
Subject: [PATCH] Better docstring for BootTest.update().

---
 boottest.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/boottest.py b/boottest.py
index ec4682e..2202918 100644
--- a/boottest.py
+++ b/boottest.py
@@ -84,7 +84,11 @@ class BootTest(object):
         return 'IN PROGRESS'
 
     def update(self, excuse):
-        """Update given 'excuse' and return True if it has failed.
+        """Update given 'excuse'.
+
+        Return True if it has already failed or still in progress (so
+        promotion should be blocked), otherwise (test skipped or passed)
+        False.
 
         Annotate skipped packages (currently not in phone image) or add
         the current testing status (see `_get_status_label`).