monitor: update interface definition: get_status() can return a Failure

diff --git a/src/allmydata/monitor.py b/src/allmydata/monitor.py
index c9f89d5ed73a4ae770017c756fe5a57015930289..7524447cf48459f7b3a9779e8d044bc762514d7b 100644 (file)
--- a/src/allmydata/monitor.py
+++ b/src/allmydata/monitor.py
@@ -44,7 +44,8 @@ class IMonitor(Interface):
         this."""
 
     def get_status(self):
-        """Return the status object."""
+        """Return the status object. If the operation failed, this will be a
+        Failure instance."""
 
     def finish(self, status):
         """Call this when the operation is done, successful or not. The