DOC: clarify parameters of FFMpegFileWriter#31253
DOC: clarify parameters of FFMpegFileWriter#31253monika-2906-git wants to merge 1 commit intomatplotlib:mainfrom
Conversation
|
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. |
scottshambaugh
left a comment
scottshambaugh
left a comment
There was a problem hiding this comment.
I think these are good arguments to more explicitly document, but please match the more detailed descriptions at https://matplotlib.org/devdocs/api/_as_gen/matplotlib.animation.FileMovieWriter.html
| Frames are written to temporary files on disk and then stitched | ||
| together at the end. | ||
|
|
||
| .. _their notes on frame rates: https://trac.ffmpeg.org/wiki/Slideshow#Framerates |
There was a problem hiding this comment.
Please state why this link is no longer relevant.
4 participants
PR summary
This PR improves the documentation of FFMpegFileWriter by expanding the parameter section of the docstring . The previous documentation only forwarde parameters to FileMovieWriter without describing them.
This change clarifies commonly used parameters such as fps, codec, bitrate, metadata, and extra_args to make the documentation easier to understand for users.
AI Disclosure
AI assistance was used to help understand the documentation structure and draft improved parameter descriptions. The final code and wording were reviewed and edited by the contributor.
PR checklist