[Pkg-bazaar-commits] ./bzr/unstable r653: doc

[Martin Pool]

------------------------------------------------------------
revno: 653
committer: Martin Pool <mbp at sourcefrog.net>
timestamp: Fri 2005-06-10 17:17:04 +1000
message:
  doc
modified:
  bzrlib/progress.py
-------------- next part --------------
=== modified file 'bzrlib/progress.py'
--- a/bzrlib/progress.py	2005-06-10 07:13:33 +0000
+++ b/bzrlib/progress.py	2005-06-10 07:17:04 +0000
@@ -61,6 +61,21 @@
 
 
 class Progress(object):
+    """Description of progress through a task.
+
+    Basically just a fancy tuple holding:
+
+    units
+        noun string describing what is being traversed, e.g.
+        "balloons", "kB"
+
+    current
+        how many objects have been processed so far
+
+    total
+        total number of objects to process, if known.
+    """
+    
     def __init__(self, units, current, total=None):
         self.units = units
         self.current = current