Merge pull request #43 from Kevinhykuo/master

Grammer update
t-makaro · Mar 8, 2019 · 632d988 · 632d988
2 parents 27277ea + ef6baf8
commit 632d988
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 15 deletions.
diff --git a/animatplot/blocks/update.py b/animatplot/blocks/update.py
@@ -15,17 +15,17 @@ class Update(Block):
         representing the frame number. It should return a matplotlib
         artist.
     length : int
-        the number of frames to display
+        The number of frames to display.
     fargs : list, optional
-        a list of arguments to pass into func
-    ax : a matplotlib.axes.Axes, optional
-        The matplotlib axes to attach the block to.
+        A list of arguments to pass into func.
+    ax : matplotlib.axes.Axes, optional
+        The matplotlib axes to which the block is attached.
         Defaults to matplotlib.pyplot.gca()
 
     Attributes
     ----------
     ax : matplotlib.axes.Axes
-        The matplotlib axes that the block is attached to.
+        The matplotlib axes to which the block is attached.
     """
     def __init__(self, func, length, fargs=[], ax=None):
         self.func = func
@@ -43,7 +43,7 @@ def __len__(self):
 
 
 class Nuke(Update):
-    """For when the other blocks just won't do
+    """For when the other blocks just won't do:
 
     This block will clear the axes and redraw using a provided
     function on every frame.
@@ -59,17 +59,17 @@ class Nuke(Update):
         The first argument to this function must be an integer
         representing the frame number.
     length : int
-        the number of frames to display
+        The number of frames to display.
     fargs : list, optional
-        a list of arguments to pass into func
-    ax : a matplotlib.axes.Axes, optional
-        The matplotlib axes to attach the block to.
+        A list of arguments to pass into func.
+    ax : matplotlib.axes.Axes, optional
+        The matplotlib axes to which the block is attached.
         Defaults to matplotlib.pyplot.gca()
 
     Attributes
     ----------
     ax : matplotlib.axes.Axes
-        The matplotlib axes that the block is attached to.
+        The matplotlib axes to which the block is attached.
     """
     def _update(self, i):
         self.ax.clear()

diff --git a/animatplot/timeline.py b/animatplot/timeline.py
@@ -8,12 +8,13 @@ class Timeline:
     Parameters
     ----------
     t : array_like
-        Gets converted to a numpy array representing
-        the time at each frame of the animation
+        Gets converted into a numpy array representing
+        the time at each frame of the animation.
     units : str, optional
-        the units the time is measured in.
+        The units in which the time is measured.
     fps : float, optional
-        indicates the number of frames per second to play
+        Indicates the number of frames per second of the animation.
+        Defaults to 10.
     log : bool, optional
         Displays the time scale logarithmically (base 10). Defaults to False.
     """