Merge pull request #21081 from dstansby/jshtml-doc

timhoffm · web-flow · commit db67ced5f5bc · 2021-09-26T22:33:06.000+02:00
Improve docs for to_jshtml()
diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst
@@ -32,7 +32,8 @@ 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 to disk use `Animation.save` or `Animation.to_html5_video`
+To save an animation use `Animation.save`, `Animation.to_html5_video`,
+or `Animation.to_jshtml`.
 
 See :ref:`ani_writer_classes` below for details about what movie formats are
 supported.
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -1299,7 +1299,20 @@ def to_html5_video(self, embed_limit=None):
             return 'Video too large to embed.'
 
     def to_jshtml(self, fps=None, embed_frames=True, default_mode=None):
-        """Generate HTML representation of the animation"""
+        """
+        Generate HTML representation of the animation.
+
+        Parameters
+        ----------
+        fps : int, optional
+            Movie frame rate (per second). If not set, the frame rate from
+            the animation's frame interval.
+        embed_frames : bool, optional
+        default_mode : str, optional
+            What to do when the animation ends. Must be one of ``{'loop',
+            'once', 'reflect'}``. Defaults to ``'loop'`` if ``self.repeat``
+            is True, otherwise ``'once'``.
+        """
         if fps is None and hasattr(self, '_interval'):
             # Convert interval in ms to frames per second
             fps = 1000 / self._interval
