Mercurial > public > mercurial-scm > hg-stable
comparison mercurial/ui.py @ 28598:c30d5ca4945b
progress: update comment to reflect implementation
Progress has been on by default in core for a while,
the comment was written before this happened.
author | timeless <timeless@mozdev.org> |
---|---|
date | Thu, 17 Mar 2016 18:34:32 +0000 |
parents | 71e12fc53b80 |
children | e35d7f131483 |
comparison
equal
deleted
inserted
replaced
28597:cd34bf29987e | 28598:c30d5ca4945b |
---|---|
1073 self._progbar.clear() | 1073 self._progbar.clear() |
1074 | 1074 |
1075 def progress(self, topic, pos, item="", unit="", total=None): | 1075 def progress(self, topic, pos, item="", unit="", total=None): |
1076 '''show a progress message | 1076 '''show a progress message |
1077 | 1077 |
1078 With stock hg, this is simply a debug message that is hidden | 1078 By default a textual progress bar will be displayed if an operation |
1079 by default, but with extensions or GUI tools it may be | 1079 takes too long. 'topic' is the current operation, 'item' is a |
1080 visible. 'topic' is the current operation, 'item' is a | |
1081 non-numeric marker of the current position (i.e. the currently | 1080 non-numeric marker of the current position (i.e. the currently |
1082 in-process file), 'pos' is the current numeric position (i.e. | 1081 in-process file), 'pos' is the current numeric position (i.e. |
1083 revision, bytes, etc.), unit is a corresponding unit label, | 1082 revision, bytes, etc.), unit is a corresponding unit label, |
1084 and total is the highest expected pos. | 1083 and total is the highest expected pos. |
1085 | 1084 |