From 397acd25f37b265c1194242f2a1963368fc02216 Mon Sep 17 00:00:00 2001 From: rasbt Date: Sat, 15 Feb 2014 15:36:30 -0500 Subject: [PATCH] updated documentation --- README.html | 24 +++++++++++++++++------- README.md | 7 ++++--- README.txt | 23 ++++++++++++++++------- pyprind/progbar.py | 1 - setup.py | 5 ++--- 5 files changed, 39 insertions(+), 21 deletions(-) diff --git a/README.html b/README.html index 20cd9eb..91f340b 100644 --- a/README.html +++ b/README.html @@ -224,9 +224,10 @@
Set whether CPU time should be reported or not

my_prbar = pyprind.ProgBar(n, track_time=False) # default = True
my_perc = pyprind.ProgPercent(n, track_time=False) # default = True

-

ProgBar objects will print the elapsed time when the computation has finished.
+

ProgBar objects will print the estimated time left and the total time
+when the computation has finished.
ProgPercent objects reports the elapsed time during the computation and prints
-the estimated finish time of the loop (see section "Examples - ProgPercent").

+the estimated finish time of the loop.

Selecting an output stream
@@ -257,7 +258,7 @@
Small note on usage in a custom Django management command.

Examples

The following examples shall illustrate the typical usage of the PyPrind package.
-A visualization can be viewed on YouTube: http://youtu.be/N3CRoB9Uo7Y

+A visualization can be viewed on YouTube: http://youtu.be/Ex05RM9vLKE

Example - Progress Bar

@@ -275,8 +276,8 @@

Example - Progress Bar

sebastian > python3 ./examples/ex1_progress_bar.py 
 0%                                    100%
-[########################################]
-Total time elapsed: 1.033 sec
+[########################################] - ETA [sec]: 0.000 sec  
+Total time elapsed: 4.481 sec
 
@@ -295,7 +296,7 @@

Example - Percentage Indicator

Screen Output

sebastian > python3 ./examples/ex1_percentage_indicator.py 
-[ 17 %]   elapsed [sec]: 3.066  | ETA [sec]: 15.000
+[ 34 %]   elapsed [sec]: 1.377  | ETA [sec]: 2.570
 
@@ -310,7 +311,16 @@

Contact

Changelog

-

VERSION 2.1.0

+

VERSION 2.2.0

+ + + + +

VERSION 2.1.1