DOC: Add constructor parameter documentation to FFMpegFileWriter #30222
Conversation
There was a problem hiding this comment.
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 us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
|
Thanks for the contribution, however I think just copy-pasting the parameters is not a good solution. Ideally, we would solve the underlying issue (which is likely a bug in Sphinx not gracefully handling multiple inheritance here). But since we don't have the resouces, maybe we should go with a pragmatic workaround. |
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.