apt/progress/__init__.py: doc string update for run()

1 files changed, 5 insertions, 1 deletions

diff --git a/apt/progress/__init__.py b/apt/progress/__init__.py
index 97090643..ca60810f 100644
--- a/apt/progress/__init__.py
+++ b/apt/progress/__init__.py
@@ -308,7 +308,11 @@ class InstallProgress(DumbInstallProgress):
         return res
 
     def run(self, pm):
-        """Start installing."""
+        """Start installing. 
+        
+        Returns the PackageManager status:
+        (pm.ResultCompleted, pm.ResultFailed, pm.ResultIncomplete)
+        """
         pid = self.fork()
         if pid == 0:
             # pm.DoInstall might raise a exception,