SF.net SVN: matplotlib:[8747] branches/v1_0_maint/lib/matplotlib/finance.py

[<jd...@us...>]

Revision: 8747
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=8747&view=rev
Author:   jdh2358
Date:     2010-10-12 17:21:39 +0000 (Tue, 12 Oct 2010)

Log Message:
-----------
tweak volume docstring for yahoo finance

Modified Paths:
--------------
    branches/v1_0_maint/lib/matplotlib/finance.py

Modified: branches/v1_0_maint/lib/matplotlib/finance.py
===================================================================
--- branches/v1_0_maint/lib/matplotlib/finance.py	2010-10-12 16:44:07 UTC (rev 8746)
+++ branches/v1_0_maint/lib/matplotlib/finance.py	2010-10-12 17:21:39 UTC (rev 8747)
@@ -47,13 +47,17 @@
     Parse the historical data in file handle fh from yahoo finance.
 
     *adjusted*
-      If True (default) replace open, close, high, low, and volume with
-      their adjusted values.
-      The adjustment is by a scale factor, S = adjusted_close/close.
-      Adjusted volume is actual volume divided by S;
-      Adjusted prices are actual prices multiplied by S.  Hence,
-      the product of price and volume is unchanged by the adjustment.
+      If True (default) replace open, close, high, and low prices with
+      their adjusted values. The adjustment is by a scale factor, S =
+      adjusted_close/close. Adjusted prices are actual prices
+      multiplied by S.
 
+      Volume is not adjusted as it is already backward split adjusted
+      by Yahoo. If you want to compute dollars traded, multiply volume
+      by the adjusted close, regardless of whether you choose adjusted
+      = True|False.
+
+    
     *asobject*
       If False (default for compatibility with earlier versions)
       return a list of tuples containing


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.