DOC: Fix more typos and minor errors

tacaswell · tacaswell · commit 8e8291c46372 · 2016-12-10T23:15:24.000-05:00
diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst
@@ -200,12 +200,11 @@ slower, these writers can be easier to debug.
    AVConvFileWriter
 
 
-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
-file-based writers in the arguments to their respective ``setup``
-methods.
+Fundamentally, a `MovieWriter` provides 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 file-based writers is in the
+arguments to their respective ``setup`` methods.
 
 
 .. autosummary::
@@ -225,7 +224,7 @@ at a time and ``finish()`` finalizes the movie and writes the output
 file to disk.  For example ::
 
    moviewriter = MovieWriter(...)
-   moveiewriter.setup(fig=fig, 'my_movie.ext', dpi=100)
+   moviewriter.setup(fig=fig, 'my_movie.ext', dpi=100)
    for j in range(n):
        update_figure(n)
        moviewriter.grab_frame()
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -68,8 +68,7 @@ def adjusted_figsize(w, h, dpi, n):
 
 # A registry for available MovieWriter classes
 class MovieWriterRegistry(object):
-    '''Registry of available writer classes by human readable name
-    '''
+    '''Registry of available writer classes by human readable name.'''
     def __init__(self):
         self.avail = dict()
         self._registered = dict()
@@ -111,7 +110,7 @@ def list(self):
         return list(self.avail.keys())
 
     def is_available(self, name):
-        '''Check if given writer is available by name
+        '''Check if given writer is available by name.
 
         Parameters
         ----------
@@ -277,6 +276,7 @@ def finish(self):
     def grab_frame(self, **savefig_kwargs):
         '''
         Grab the image information from the figure and save as a movie frame.
+
         All keyword arguments in savefig_kwargs are passed on to the 'savefig'
         command that saves the figure.
         '''
@@ -344,7 +344,7 @@ def isAvailable(cls):
 
 
 class FileMovieWriter(MovieWriter):
-    '''`MovieWriter` for writing to individual files and stitching at the end
+    '''`MovieWriter` for writing to individual files and stitching at the end.
 
     This must be sub-classed to be useful.
     '''
@@ -483,7 +483,7 @@ def cleanup(self):
 # Base class of ffmpeg information. Has the config keys and the common set
 # of arguments that controls the *output* side of things.
 class FFMpegBase(object):
-    '''Mixin class for FFMpeg output
+    '''Mixin class for FFMpeg output.
 
     To be useful this must be multiply-inherited from with a
     `MovieWriterBase` sub-class.
@@ -537,7 +537,7 @@ def _args(self):
 # Combine FFMpeg options with temp file-based writing
 @writers.register('ffmpeg_file')
 class FFMpegFileWriter(FileMovieWriter, FFMpegBase):
-    '''File-based ffmpeg writer
+    '''File-based ffmpeg writer.
 
     Frames are written to temporary files on disk and then stitched
     together at the end.
@@ -557,7 +557,7 @@ def _args(self):
 # Base class of avconv information.  AVConv has identical arguments to
 # FFMpeg
 class AVConvBase(FFMpegBase):
-    '''Mixin class for avconv output
+    '''Mixin class for avconv output.
 
     To be useful this must be multiply-inherited from with a
     `MovieWriterBase` sub-class.
@@ -580,7 +580,7 @@ class AVConvWriter(AVConvBase, FFMpegWriter):
 # Combine AVConv options with file-based writing
 @writers.register('avconv_file')
 class AVConvFileWriter(AVConvBase, FFMpegFileWriter):
-    '''File-based avconv writer
+    '''File-based avconv writer.
 
     Frames are written to temporary files on disk and then stitched
     together at the end.
@@ -668,7 +668,7 @@ def _args(self):
 
 # Base class for animated GIFs with convert utility
 class ImageMagickBase(object):
-    '''Mixin class for ImageMagick output
+    '''Mixin class for ImageMagick output.
 
     To be useful this must be multiply-inherited from with a
     `MovieWriterBase` sub-class.
@@ -706,7 +706,7 @@ def _init_from_registry(cls):
     @classmethod
     def isAvailable(cls):
         '''
-        Check to see if a ImageMagickWriter is actually available
+        Check to see if a ImageMagickWriter is actually available.
 
         Done by first checking the windows registry (if applicable) and then
         running the commandline tool.
@@ -725,7 +725,7 @@ def isAvailable(cls):
 # former.
 @writers.register('imagemagick')
 class ImageMagickWriter(ImageMagickBase, MovieWriter):
-    '''Pipe-based animated gif
+    '''Pipe-based animated gif.
 
     Frames are streamed directly to ImageMagick via a pipe and written
     in a single pass.
@@ -745,7 +745,7 @@ def _args(self):
 # former.
 @writers.register('imagemagick_file')
 class ImageMagickFileWriter(ImageMagickBase, FileMovieWriter):
-    '''File-based animated gif writer
+    '''File-based animated gif writer.
 
     Frames are written to temporary files on disk and then stitched
     together at the end.
@@ -873,7 +873,7 @@ class to use, such as 'ffmpeg' or 'mencoder'. If `None`,
            default to ``rcParams['animation.codec']``
 
         bitrate : number, optional
-           Specifies the amount of bits used per second in the
+           Specifies the number 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
@@ -1184,7 +1184,7 @@ def _repr_html_(self):
 
 
 class TimedAnimation(Animation):
-    ''':class:`Animation` subclass for time-based animation
+    ''':class:`Animation` subclass for time-based animation.
 
     A new frame is drawn every *interval* milliseconds.
 
@@ -1199,7 +1199,7 @@ class TimedAnimation(Animation):
 
     repeat_delay : number, optional
         If the animation in repeated, adds a delay in milliseconds
-        before repeating the animation.  Defaults to None
+        before repeating the animation.  Defaults to `None`
 
     repeat : bool, optional
         Controls whether the animation should repeat when the sequence
@@ -1284,7 +1284,7 @@ class ArtistAnimation(TimedAnimation):
         be disabled for other frames.
 
     interval : number, optional
-       Delay between frames in miliseconds.  Defaults to 200.
+       Delay between frames in milliseconds.  Defaults to 200.
 
     repeat_delay : number, optional
         If the animation in repeated, adds a delay in milliseconds
@@ -1346,7 +1346,8 @@ def _draw_frame(self, artists):
 
 
 class FuncAnimation(TimedAnimation):
-    '''Makes an animation by repeatedly calling a function ``func``
+    '''
+    Makes an animation by repeatedly calling a function ``func``.
 
 
     Parameters
@@ -1410,7 +1411,7 @@ def init_func() -> iterable_of_artists:
 
     repeat : bool, optional
        Controls whether the animation should repeat when the sequence
-       of frames is completed.  Defaults to `True`
+       of frames is completed.  Defaults to `True`.
 
     blit : bool, optional
        Controls whether blitting is used to optimize drawing.  Defaults
