DOC: Improve writer parameter docs of Animation.save() - #30910
Conversation
Sorry, something went wrong.
story645
left a comment
There was a problem hiding this comment.
thanks for taking this on!
Sorry, something went wrong.
| The writer to use. This can be an instance of an `AbstractMovieWriter` | ||
| subclass or a string. The builtin writers are |
There was a problem hiding this comment.
| 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.
Sorry, something went wrong.
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.
Sorry, something went wrong.
There was a problem hiding this comment.
I like the explanation of writer much better.
Sorry, something went wrong.
There was a problem hiding this comment.
changed
Sorry, something went wrong.
…nimation.save()
…nimation.save()
…ave() (#30924) Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
…910-on-v3.10.8-doc Backport PR #30910 on branch v3.10.8-doc (DOC: Improve writer parameter docs of Animation.save())
…nimation.save()
…t-of-pr-30910-on-v3.10.8-doc Backport PR matplotlib#30910 on branch v3.10.8-doc (DOC: Improve writer parameter docs of Animation.save())
Closes #24159.
Note: type stubs already define the type as AbstractMovieWriter:
matplotlib/lib/matplotlib/animation.pyi
Line 171 in 0dc49d9