Permalink
Browse files

updating readme from library doc strings

  • Loading branch information...
1 parent 06acded commit 3cdf1e1399fd502ff771e0a8a8e25e88e33778d1 @terencehonles terencehonles committed May 15, 2011
Showing with 16 additions and 15 deletions.
  1. +16 −15 README.txt
View
@@ -1,18 +1,19 @@
-Text progress bar library for python.
+Text progress bar library for Python.
-This library provides a text mode progress bar. This is typically used
-to display the progress of a long running operation, providing a
-visual clue that processing is underway.
+A text progress bar is typically used to display the progress of a long
+running operation, providing a visual cue that processing is underway.
-The ProgressBar class manages the progress, and the format of the line
-is given by a number of widgets. A widget is an object that may
-display differently depending on the state of the progress. There are
-three types of widget:
-- a string, which always shows itself;
-- a ProgressBarWidget, which may return a different value every time
-it's update method is called; and
-- a ProgressBarWidgetHFill, which is like ProgressBarWidget, except it
-expands to fill the remaining width of the line.
+The ProgressBar class manages the current progress, and the format of the line
+is given by a number of widgets. A widget is an object that may display
+differently depending on the state of the progress bar. There are three types
+of widgets:
+ - a string, which always shows itself
-The progressbar module is very easy to use, yet very powerful. And
-automatically supports features like auto-resizing when available.
+ - a ProgressBarWidget, which may return a different value every time its
+ update method is called
+
+ - a ProgressBarWidgetHFill, which is like ProgressBarWidget, except it
+ expands to fill the remaining width of the line.
+
+The progressbar module is very easy to use, yet very powerful. It will also
+automatically enable features like auto-resizing when the system supports it.

0 comments on commit 3cdf1e1

Please sign in to comment.