Permalink
Browse files

updated docs

  • Loading branch information...
1 parent e98b28b commit 83a3e652d4a32fa252c2a0ca400d4dc3efe54328 @WoLpH committed Sep 23, 2013
Showing with 4 additions and 1 deletion.
  1. +1 −1 docs/progressbar.rst
  2. +3 −0 progressbar/__init__.py
View
@@ -4,7 +4,7 @@ progressbar Package
:mod:`progressbar` Package
--------------------------
-.. automodule:: progressbar.__init__
+.. automodule:: progressbar
:members:
:undoc-members:
:show-inheritance:
View
@@ -79,6 +79,7 @@ class ProgressBar(object):
'''The ProgressBar class which updates and prints the bar.
A common way of using it is like:
+
>>> pbar = ProgressBar().start()
>>> for i in range(100):
... pbar.update(i+1)
@@ -87,6 +88,7 @@ class ProgressBar(object):
>>> pbar.finish()
You can also use a ProgressBar as an iterator:
+
>>> progress = ProgressBar()
>>> some_iterable = range(100)
>>> for i in progress(some_iterable):
@@ -312,6 +314,7 @@ def start(self):
'''Starts measuring time, and prints the bar at 0%.
It returns self so you can use it like this:
+
>>> pbar = ProgressBar().start()
>>> for i in range(100):
... # do something

0 comments on commit 83a3e65

Please sign in to comment.