interfaces.py: improve ICheckAndRepairResults docs a bit

diff --git a/src/allmydata/interfaces.py b/src/allmydata/interfaces.py
index fc82018162fe9540c9dc4a506cd5d73052aadfb1..73aa8b7ecbb4620b7855180765cdef9078f6b03a 100644 (file)
--- a/src/allmydata/interfaces.py
+++ b/src/allmydata/interfaces.py
@@ -1829,7 +1829,10 @@ class ICheckAndRepairResults(Interface):
     def get_storage_index_string():
         """Return a string with the (printable) abbreviated storage index."""
     def get_repair_attempted():
-        """Return a boolean, True if a repair was attempted."""
+        """Return a boolean, True if a repair was attempted. We might not
+        attempt to repair the file because it was healthy, or healthy enough
+        (i.e. some shares were missing but not enough to exceed some
+        threshold), or because we don't know how to repair this object."""
     def get_repair_successful():
         """Return a boolean, True if repair was attempted and the file/dir
         was fully healthy afterwards. False if no repair was attempted or if