Skip to content

[Doc]: clarify which writers animation.save supports #24159

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.

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

Open
story645 opened this issue Oct 14, 2022 · 1 comment
Open

[Doc]: clarify which writers animation.save supports #24159

story645 opened this issue Oct 14, 2022 · 1 comment

Comments

@story645
Copy link
Member

Documentation Link

https://matplotlib.org/devdocs/api/_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation.save

Problem

Save can support multiple writers, but the only one that's documented is MovieWriter

image

Suggested improvement

Update the documentation so that all the supported writers are mentioned, possibly something like

writer supported file types dependency
PillowWriter GIF (are APNG and MPEG supported?) Pillow
etc...

I honestly can not really make heads or tails of which writers are supported looking through the docs 'cause PillowWriter is supported but isn't a MovieWriter and MovieWriter isn't supported directly but is a baseclass of the supported writers. Unless the documentation was supposed to read AbstractMovieWriter? 😕

image

@story645 story645 changed the title [Doc]: clartify which writers animation.save supports [Doc]: clarify which writers animation.save supports Oct 14, 2022
@dopplershift
Copy link
Contributor

AbstractMovieWriter wasn't around when at least I wrote the docs. Probably should say something like "subclass of AbstractMovieWriter" or "concrete implementation", or..?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants