DOC: Improve writer parameter docs of Animation.save()#30910
Merged
story645 merged 1 commit intomatplotlib:mainfrom Jan 2, 2026
Merged
DOC: Improve writer parameter docs of Animation.save()#30910story645 merged 1 commit intomatplotlib:mainfrom
story645 merged 1 commit intomatplotlib:mainfrom
Conversation
story645
reviewed
Jan 2, 2026
lib/matplotlib/animation.py
Outdated
Comment on lines
+959
to
+960
| The writer to use. This can be an instance of an `AbstractMovieWriter` | ||
| subclass or a string. The builtin writers are |
Member
There was a problem hiding this comment.
Suggested change
| The writer to use. This can be an instance of an `AbstractMovieWriter` | |
| subclass or a string. The builtin writers are | |
| An instance of an `AbstractMovieWriter` subclass or an identifying string. The builtin writers are |
I don't think writer to use is adding anything here.
Member
Author
There was a problem hiding this comment.
We (should) always start with an expression or sentence what the effect of the parameter is. I believe this is valuable to state explicitly, even if one can mostly guess what this is for; e.g. we also have
More informative wording welcome; e.g. how about
The writer used to grab the frames and create the movie file.
Member
There was a problem hiding this comment.
I like the explanation of writer much better.
timhoffm
force-pushed
the
doc-animation.save-writer
branch
from
56b9276 to
b52aac2
Compare
story645
approved these changes
Jan 2, 2026
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jan 2, 2026
…nimation.save()
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jan 2, 2026
…nimation.save()
timhoffm
added a commit
that referenced
this pull request
Jan 2, 2026
…ave() (#30924) Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
timhoffm
added a commit
that referenced
this pull request
Jan 2, 2026
…910-on-v3.10.8-doc Backport PR #30910 on branch v3.10.8-doc (DOC: Improve writer parameter docs of Animation.save())
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #24159.
Note: type stubs already define the type as AbstractMovieWriter:
matplotlib/lib/matplotlib/animation.pyi
Line 171 in 0dc49d9