From 4194565b3d3339aa4acf83aa511ef2b4dc99d87b Mon Sep 17 00:00:00 2001
From: Brian Warner <warner@lothar.com>
Date: Tue, 30 Jun 2009 17:19:25 -0700
Subject: [PATCH] interfaces.py: improve ICheckAndRepairResults docs a bit

---
 src/allmydata/interfaces.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/allmydata/interfaces.py b/src/allmydata/interfaces.py
index fc820181..73aa8b7e 100644
--- 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
-- 
2.45.2