wrapped candlestick2 to have new argument order

tacaswell · tacaswell · commit 35d70d8fcefe · 2013-07-21T16:31:47.000-05:00
diff --git a/lib/matplotlib/finance.py b/lib/matplotlib/finance.py
@@ -512,8 +512,33 @@ def plot_day_summary_ohlc(ax, opens, highs, lows, closes, ticksize=4,
     ax.add_collection(closeCollection)
     return rangeCollection, openCollection, closeCollection
 
+def candlestick_ochl(ax, opens, closes, highs, lows,  width=4,
+                 colorup='k', colordown='r',
+                 alpha=0.75,
+                 ):
+    """
+
+    Represent the open, close as a bar line and high low range as a
+    vertical line.
+
+    Preserves the original argument order.
+
+    ax          : an Axes instance to plot to
+    width       : the bar width in points
+    colorup     : the color of the lines where close >= open
+    colordown   : the color of the lines where close <  open
+    alpha       : bar transparency
+
+    return value is lineCollection, barCollection
+    """
+
+    candlestick_ohlc(ax, opens, closes, highs, lows, width=width,
+                     colorup=colorup, colordown=colordown,
+                     alpha=alpha)
+
+candlestick2 = candlestick_ochl
 
-def candlestick2(ax, opens, highs, lows, closes, width=4,
+def candlestick_ohlc(ax, opens, highs, lows, closes, width=4,
                  colorup='k', colordown='r',
                  alpha=0.75,
                  ):
