Skip to content

Add Returns info to to_jshtml docstring #28706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 7, 2024
Merged

Add Returns info to to_jshtml docstring #28706

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e776ce7
Add Returns documentation to `to_jshtml` function
s7726 Aug 12, 2024
0773109
Fix return to match docstring standards
s7726 Aug 12, 2024
0946afe
Link to HTMLWriter docs
rcomer Sep 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions lib/matplotlib/animation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading