add comments to animation demos

Author: DanielGoldfarb

examples/external_axes.ipynb

@@ -1,3 +1,10 @@
+'''
+This file contains a simple animation demo using mplfinance "external axes mode".
+
+Note that presently mplfinance does not support "blitting" (blitting makes animation
+more efficient).  Nonetheless, the animation is efficient enough to update at least
+once per second, and typically more frequently depending on the size of the plot.
+'''
 import pandas as pd
 import mplfinance as mpf
 import matplotlib.animation as animation

examples/mpf_animation_demo1.py

@@ -1,3 +1,17 @@
+'''
+This file contains a simple animation demo using mplfinance "external axes mode".
+
+In this example, instead of creating the Figure and Axes external to mplfiance,
+we allow mplfinance to create the Figure and Axes using its "panel method", and
+set kwarg `returnfig=True` so that mplfinance will return the Figure and Axes.
+
+We then take those Axes and pass them back into mplfinance ("external axes mode")
+as part of the animation.
+
+Note that presently mplfinance does not support "blitting" (blitting makes animation
+more efficient).  Nonetheless, the animation is efficient enough to update at least
+once per second, and typically more frequently depending on the size of the plot.
+'''
 import pandas as pd
 import mplfinance as mpf
 import matplotlib.animation as animation
@@ -8,7 +22,9 @@
 
 pkwargs=dict(type='candle',mav=(10,20))
 
-fig, axes = mpf.plot(df.iloc[0:20],returnfig=True,volume=True,figsize=(11,8),panel_ratios=(2,1),title='\n\nS&P 500 ETF',**pkwargs)
+fig, axes = mpf.plot(df.iloc[0:20],returnfig=True,volume=True,
+                     figsize=(11,8),panel_ratios=(2,1),
+                     title='\n\nS&P 500 ETF',**pkwargs)
 ax1 = axes[0]
 ax2 = axes[2]
 

examples/mpf_animation_demo2.py

@@ -1,3 +1,19 @@
+'''
+This file contains a animation demo using mplfinance "external axes mode",
+in which animate both the display of candlesticks as well as the display
+of MACD (Moving Average Convergence Divergence) visual analysis.
+
+In this example, instead of creating the Figure and Axes external to mplfiance,
+we allow mplfinance to create the Figure and Axes using its "panel method", and
+set kwarg `returnfig=True` so that mplfinance will return the Figure and Axes.
+
+We then take those Axes and pass them back into mplfinance ("external axes mode")
+as part of the animation.
+
+Note that presently mplfinance does not support "blitting" (blitting makes animation
+more efficient).  Nonetheless, the animation is efficient enough to update at least
+once per second, and typically more frequently depending on the size of the plot.
+'''
 import pandas as pd
 import mplfinance as mpf
 import matplotlib.animation as animation