Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: Add constructor parameter documentation to FFMpegFileWriter#30222
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join uson gitter for real-time discussion.
For details on testing, writing docs, and our review process, please seethe developer guide
We strive to be a welcoming and open project. Please follow ourCode of Conduct.
Summary
Closes#22831
This PR improves the documentation for
matplotlib.animation.FFMpegFileWriterby explicitly listing the constructor parameters (fps,codec,bitrate,extra_args, andmetadata) in the class docstring.Why this matters
The class currently inherits these parameters via
*argsand**kwargs, making them invisible in the Sphinx-generated documentation. By adding the parameters directly to the class docstring following the NumPy docstring standard, users will now be able to see and understand how to use the writer more effectively.What was done
FFMpegFileWriterclass docstring inanimation.pyAdditional Notes
If accepted, the same approach could be applied to similar classes like
ImageMagickFileWriterthat suffer from the same inheritance visibility issue.