Skip to content

Commit

Permalink
Add note about autorefresh
Browse files Browse the repository at this point in the history
  • Loading branch information
avylove committed Jun 19, 2020
1 parent 2640408 commit e93d7b2
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions enlighten/_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,8 @@ def counter(self, position=None, **kwargs):
has already been pinned by another counter.
If ``autorefresh`` is :py:data:`True`, this bar will be redrawn whenever another bar is
drawn assuming it had been ``min_delta`` seconds since the last update.
drawn assuming it had been ``min_delta`` seconds since the last update. This is usually
unnecessary.
.. note:: Counters are not automatically drawn when created because fields may be missing
if subcounters are used. To force the counter to draw before updating,
Expand All @@ -170,7 +171,8 @@ def status_bar(self, *args, **kwargs):
additional counters are called without a ``position`` argument.
If ``autorefresh`` is :py:data:`True`, this bar will be redrawn whenever another bar is
drawn assuming it had been ``min_delta`` seconds since the last update.
drawn assuming it had been ``min_delta`` seconds since the last update. Generally,
only need when ``elapsed`` is used in :ref:`status_format <status_format>`.
"""

Expand Down

0 comments on commit e93d7b2

Please sign in to comment.