Add Returns documentation to to_jshtml function

s7726 · rcomer · commit e776ce788f45 · 2024-09-07T13:17:19.000+01:00
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -1311,6 +1311,12 @@ def to_jshtml(self, fps=None, embed_frames=True, default_mode=None):
             What to do when the animation ends. Must be one of ``{'loop',
             'once', 'reflect'}``. Defaults to ``'loop'`` if the *repeat*
             parameter is True, otherwise ``'once'``.
+
+        Returns
+        -------
+        str
+            An HTML representation of the animation embedded as a js object as
+            produced with the ``HTMLWriter``.
         """
         if fps is None and hasattr(self, '_interval'):
             # Convert interval in ms to frames per second
