update docs

Author: ddkohler

CHANGELOG.md

@@ -7,9 +7,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
 ### Added
 - new artists submodule `animate` as a convenient wrapper for matplotlib's `FuncAnimate`
+- `animate.animate2D`: allows versatile conversion of data to animation.
+- `animate.animate_interact2D`: create an animation from an interact2D object.
+- `animate.animate_quick2D`: create an animation whose frames are the figures that would be created in a quick2D call
 
 ### Changed
 - `interact2D`: replaced SimpleNamespace object with a dataclass for more explicit typing
+- `quick2D`: `__iter__` method added which modifies the same figure over and over instead of writing new figures for each chop object
 
 ### Fixed
 - WrightTools works with new h5py 3.16

WrightTools/artists/_animate.py

@@ -133,19 +133,23 @@ def animate_quick2D(data, *args, **kwargs):
     """
     animate a quick2D series
 
-    function accepts same arguments as Quick2D
+    function accepts same arguments as artists.Quick2D
 
     animation kwargs can be passed through a dictionary `fa_kwargs`
+
+    unlike other animation functions, this enforces repeat=False
     """
 
+    # trying for minimal code here, and just drawing from quick2D's constructs
+    # quick2D is constructed as a generator, so looping and reversing is 
+    # not simple to implement
     fa_kwargs = kwargs.pop("fa_kwargs", dict())
     q2d = _quick2D(data, *args, **kwargs)
     generator = q2d.__iter__()
     fig = generator.__next__()
-    print(q2d.nfigs)
 
     def updater(frame):
-        print(f"{frame=}")
+        logger.info(f"{frame=}")
         generator.__next__()
         fig.canvas.draw_idle()
         return