progress: update comment to reflect implementation
authortimeless <timeless@mozdev.org>
Thu, 17 Mar 2016 18:34:32 +0000
changeset 28598 c30d5ca4945b
parent 28597 cd34bf29987e
child 28599 0e7a929754aa
progress: update comment to reflect implementation Progress has been on by default in core for a while, the comment was written before this happened.
mercurial/ui.py
--- a/mercurial/ui.py	Sun Mar 20 04:54:35 2016 +0000
+++ b/mercurial/ui.py	Thu Mar 17 18:34:32 2016 +0000
@@ -1075,9 +1075,8 @@
     def progress(self, topic, pos, item="", unit="", total=None):
         '''show a progress message
 
-        With stock hg, this is simply a debug message that is hidden
-        by default, but with extensions or GUI tools it may be
-        visible. 'topic' is the current operation, 'item' is a
+        By default a textual progress bar will be displayed if an operation
+        takes too long. 'topic' is the current operation, 'item' is a
         non-numeric marker of the current position (i.e. the currently
         in-process file), 'pos' is the current numeric position (i.e.
         revision, bytes, etc.), unit is a corresponding unit label,