From: Brian Warner <warner@lothar.com>
Date: Wed, 1 Jul 2009 00:19:25 +0000 (-0700)
Subject: interfaces.py: improve ICheckAndRepairResults docs a bit
X-Git-Tag: trac-4000~47
X-Git-Url: https://git.rkrishnan.org/pf/content/-?a=commitdiff_plain;h=4194565b3d3339aa4acf83aa511ef2b4dc99d87b;p=tahoe-lafs%2Ftahoe-lafs.git

interfaces.py: improve ICheckAndRepairResults docs a bit
---

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