DOC MEP12 - converted animation to SG/MEP12 compatible

NelleV · NelleV · commit 774b54d24f98 · 2016-10-30T10:03:54.000-07:00
diff --git a/examples/animation/animate_decay.py b/examples/animation/animate_decay.py
@@ -1,3 +1,12 @@
+"""
+=====
+Decay
+=====
+
+This example showcases a sinusoidal decay animation.
+"""
+
+
 import numpy as np
 import matplotlib.pyplot as plt
 import matplotlib.animation as animation
diff --git a/examples/animation/basic_example.py b/examples/animation/basic_example.py
@@ -1,3 +1,12 @@
+"""
+=========================
+Simple animation examples
+=========================
+
+This example contains two animations. The first is a random walk plot. the
+second is an image animation.
+"""
+
 import numpy as np
 import matplotlib.pyplot as plt
 import matplotlib.animation as animation
@@ -17,7 +26,8 @@ def update_line(num, data, line):
 plt.title('test')
 line_ani = animation.FuncAnimation(fig1, update_line, 25, fargs=(data, l),
                                    interval=50, blit=True)
-#line_ani.save('lines.mp4')
+
+# To save the animation, use the command: line_ani.save('lines.mp4')
 
 fig2 = plt.figure()
 
@@ -30,6 +40,7 @@ def update_line(num, data, line):
 
 im_ani = animation.ArtistAnimation(fig2, ims, interval=50, repeat_delay=3000,
                                    blit=True)
-#im_ani.save('im.mp4', metadata={'artist':'Guido'})
+# To save this second animation with some metadata, use the following command:
+# im_ani.save('im.mp4', metadata={'artist':'Guido'})
 
 plt.show()
diff --git a/examples/animation/basic_example_writer.py b/examples/animation/basic_example_writer.py
@@ -1,5 +1,13 @@
-# Same as basic_example, but writes files using a single MovieWriter instance
-# without putting on screen
+"""
+===================
+Saving an animation
+===================
+
+This example showcases the same animations as `basic_example.py`, but instead
+of displaying the animation to the user, it writes to files using a
+MovieWriter instance.
+"""
+
 # -*- noplot -*-
 import numpy as np
 import matplotlib
diff --git a/examples/animation/bayes_update.py b/examples/animation/bayes_update.py
@@ -1,3 +1,14 @@
+"""
+================
+The Bayes update
+================
+
+This animation displays the posterior estimate updates as it is refitted when
+new data arrives.
+The vertical line represents the theoretical value to which the plotted
+distribution should converge.
+"""
+
 # update a distribution based on new data.
 import numpy as np
 import matplotlib.pyplot as plt
