DOC: address the rest of the comments

tacaswell · tacaswell · commit 1a6c61c8fa62 · 2016-12-10T22:05:45.000-05:00
diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst
@@ -13,7 +13,7 @@
 Animation
 =========
 
-The easiest way to make a live animation in mpl is to use one of the
+The easiest way to make a live animation in matplotlib is to use one of the
 `Animation` classes.
 
 .. autosummary::
@@ -30,7 +30,7 @@ to.  If you do not hold a reference to the `Animation` object, it (and
 hence the timers), will be garbage collected which will stop the
 animation.
 
-To save an animation use to disk use
+To save an animation to disk use
 
 .. autosummary::
    :toctree: _as_gen
@@ -48,7 +48,7 @@ See :ref:`ani_writer_classes` below for details about what movie formats are sup
 The inner workings of `FuncAnimation` is more-or-less::
 
   for d in frames:
-     arts = func(d, *fargs)
+     artists = func(d, *fargs)
      fig.canvas.draw_idle()
      plt.pause(interval)
 
@@ -59,7 +59,7 @@ axes, and easily save the animation to a movie file.
 
 'Blitting' is a `old technique
 <https://en.wikipedia.org/wiki/Bit_blit>`__ in computer graphics.  The
-general gist is to take as existing bit map (in our case a mostly
+general gist is to take an existing bit map (in our case a mostly
 rasterized figure) and then 'blit' one more artist on top.  Thus, by
 managing a saved 'clean' bitmap, we can only re-draw the few artists
 that are changing at each frame and possibly save significant amounts of
@@ -68,24 +68,24 @@ time.  When using blitting (by passing ``blit=True``) the core loop of
 
    ax = fig.gca()
 
-   def update_blit(arts):
+   def update_blit(artists):
        fig.canvas.restore_region(bg_cache)
-       for a in arts:
+       for a in artists:
            a.axes.draw_artist(a)
 
        ax.figure.canvas.blit(ax.bbox)
 
-   arts = init_func()
+   artists = init_func()
 
-   for a in arts:
+   for a in artists:
       a.set_animated(True)
 
    fig.canvas.draw()
    bg_cache = fig.canvas.copy_from_bbox(ax.bbox)
 
    for f in frames:
-       arts = func(f, *fargs)
-       update_blit(arts)
+       artists = func(f, *fargs)
+       update_blit(artists)
        plt.pause(interval)
 
 This is of course leaving out many details (such as updating the
@@ -98,7 +98,7 @@ The expected signature on ``func`` and ``init_func`` is very simple to
 keep `FuncAnimation` out of your book keeping and plotting logic, but
 this means that the callable objects you pass in must know what
 artists they should be working on.  There are several approaches to
-handling this, of varying complexity and encapsulation.   The simplest
+handling this, of varying complexity and encapsulation.  The simplest
 approach, which works quite well in the case of a script, is to define the
 artist at a global scope and let Python sort things out.  For example ::
 
@@ -200,7 +200,7 @@ slower, these writers can be easier to debug.
    AVConvFileWriter
 
 
-Fundamentally, a MovieWriter does is provide is a way to grab
+Fundamentally, a `MovieWriter` does is provide is a way to grab
 sequential frames from the same underlying `~matplotlib.figure.Figure`
 object.  The base class `MovieWriter` implements 3 methods and a
 context manager.  The only difference between the pipe-based and
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -486,7 +486,7 @@ class FFMpegBase(object):
     '''Mixin class for FFMpeg output
 
     To be useful this must be multiply-inherited from with a
-    `MoveWriterBase` sub-class.
+    `MovieWriterBase` sub-class.
     '''
 
     exec_key = 'animation.ffmpeg_path'
@@ -560,7 +560,7 @@ class AVConvBase(FFMpegBase):
     '''Mixin class for avconv output
 
     To be useful this must be multiply-inherited from with a
-    `MoveWriterBase` sub-class.
+    `MovieWriterBase` sub-class.
     '''
 
     exec_key = 'animation.avconv_path'
@@ -671,7 +671,7 @@ class ImageMagickBase(object):
     '''Mixin class for ImageMagick output
 
     To be useful this must be multiply-inherited from with a
-    `MoveWriterBase` sub-class.
+    `MovieWriterBase` sub-class.
     '''
 
     exec_key = 'animation.convert_path'
@@ -850,7 +850,7 @@ def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
         ----------
 
         filename : str
-            the output filename, e.g., :file:`mymovie.mp4`
+            The output filename, e.g., :file:`mymovie.mp4`
 
         writer : :class:`MovieWriter` or str, optional
             A `MovieWriter` instance to use or a key that identifies a
@@ -863,48 +863,48 @@ class to use, such as 'ffmpeg' or 'mencoder'. If `None`,
            the frames per second.
 
         dpi : number, optional
-           controls the dots per inch for the movie frames. This
+           Controls the dots per inch for the movie frames.  This
            combined with the figure's size in inches controls the size of
            the movie.  If None, defaults to ``rcparam['savefig.dpi']``
 
         codec : str, optional
-           the video codec to be used. Not all codecs are supported by
+           The video codec to be used. Not all codecs are supported by
            a given :class:`MovieWriter`. If `None`,
            default to ``rcParams['animation.codec']``
 
         bitrate : number, optional
-           specifies the amount of bits used per second in the
+           Specifies the amount of bits used per second in the
            compressed movie, in kilobits per second. A higher number
            means a higher quality movie, but at the cost of increased
            file size. If `None`, defaults to
            ``rcParam['animation.bitrate']``
 
         extra_args : list, optional
-           list of extra string arguments to be passed to the
+           List of extra string arguments to be passed to the
            underlying movie utility. If `None`, defaults to
            ``rcParams['animation.extra_args']``
 
         metadata : dict, optional
-           dictionary of keys and values for metadata to include in
+           Dictionary of keys and values for metadata to include in
            the output file. Some keys that may be of use include:
            title, artist, genre, subject, copyright, srcform, comment.
 
         extra_anim : list, optional
-           additional `Animation` objects that should be included in
+           Additional `Animation` objects that should be included in
            the saved movie file. These need to be from the same
            `matplotlib.Figure` instance. Also, animation frames will
            just be simply combined, so there should be a 1:1
            correspondence between the frames from the different
            animations.
 
         savefig_kwargs : dict, optional
-           is a dictionary containing keyword arguments to be passed
+           Is a dictionary containing keyword arguments to be passed
            on to the 'savefig' command which is called repeatedly to
            save the individual frames.
 
         Notes
         -----
-        fps, codec, bitrate, extra_args, metadata are used are used to
+        fps, codec, bitrate, extra_args, metadata are used to
         construct a :class:`MovieWriter` instance and can only be
         passed if `writer` is a string.  If they are passed as
         non-`None` and ``writer`` is a :class:`MovieWriter`, a
@@ -1201,13 +1201,13 @@ class TimedAnimation(Animation):
         If the animation in repeated, adds a delay in milliseconds
         before repeating the animation.  Defaults to None
 
-    repeat: bool, optional
-        controls whether the animation should repeat when the sequence
+    repeat : bool, optional
+        Controls whether the animation should repeat when the sequence
         of frames is completed. Defaults to `True`.
 
     blit : bool, optional
-       controls whether blitting is used to optimize drawing.  Defaults
-       to `False`.
+        Controls whether blitting is used to optimize drawing.  Defaults
+        to `False`.
 
     '''
     def __init__(self, fig, interval=200, repeat_delay=None, repeat=True,
@@ -1279,7 +1279,7 @@ class ArtistAnimation(TimedAnimation):
        other needed events.
 
     artists : list
-        with each list entry a collection of artists that
+        With each list entry a collection of artists that
         represent what needs to be enabled on each frame. These will
         be disabled for other frames.
 
@@ -1290,13 +1290,13 @@ class ArtistAnimation(TimedAnimation):
         If the animation in repeated, adds a delay in milliseconds
         before repeating the animation.  Defaults to `None`.
 
-    repeat: bool, optional
-        controls whether the animation should repeat when the sequence
+    repeat : bool, optional
+        Controls whether the animation should repeat when the sequence
         of frames is completed. Defaults to `True`.
 
     blit : bool, optional
-       controls whether blitting is used to optimize drawing.  Defaults
-       to `False`.
+        Controls whether blitting is used to optimize drawing.  Defaults
+        to `False`.
 
     '''
     def __init__(self, fig, artists, *args, **kwargs):
@@ -1374,12 +1374,16 @@ def func(fr: object, *fargs) -> iterable_of_artists:
 
         If a generator function, then must have the signature ::
 
-           def gen_function():
+           def gen_function() -> obj:
+
+        In all of these cases, the values in `frames` is simply
+        passed through to the user-supplied `func` and thus can be
+        of any type.
 
-        If `None`, then equivalent to passing ``itertools.count``
+        If `None`, then equivalent to passing ``itertools.count``.
 
     init_func : callable, optional
-       a function used to draw a clear frame. If not given, the
+       A function used to draw a clear frame. If not given, the
        results of drawing from the first item in the frames sequence
        will be used. This function will be called once before the
        first frame.
@@ -1404,12 +1408,12 @@ def init_func() -> iterable_of_artists:
        If the animation in repeated, adds a delay in milliseconds
        before repeating the animation.  Defaults to `None`.
 
-    repeat: bool, optional
-       controls whether the animation should repeat when the sequence
+    repeat : bool, optional
+       Controls whether the animation should repeat when the sequence
        of frames is completed.  Defaults to `True`
 
     blit : bool, optional
-       controls whether blitting is used to optimize drawing.  Defaults
+       Controls whether blitting is used to optimize drawing.  Defaults
        to `False`.
 
     '''
