Title: DOC: Add parameters documentation for FFMpegFileWriter by saumyacoder1709 · Pull Request #30820 · matplotlib/matplotlib · GitHub
Open Graph Title: DOC: Add parameters documentation for FFMpegFileWriter by saumyacoder1709 · Pull Request #30820 · matplotlib/matplotlib
X Title: DOC: Add parameters documentation for FFMpegFileWriter by saumyacoder1709 · Pull Request #30820 · matplotlib/matplotlib
Description: PR summary This PR improves the documentation for FFMpegFileWriter by clarifying what parameters can be passed via *args and **kwargs. Problem: The current documentation doesn't explain what arguments *args, **kwargs accept, leaving users confused about how to use the class. Solution: Added a Parameters section to the docstring that explicitly documents that all arguments are forwarded to the parent class FileMovieWriter, directing users to the appropriate documentation. Changes: Added Parameters section to FFMpegFileWriter docstring Documented that *args, **kwargs are forwarded to FileMovieWriter Follows NumPy docstring conventions This makes the API more discoverable and user-friendly. PR checklist "closes #22831" is in the body of the PR description to link the related issue [N/A] new and changed code is tested (documentation-only change) [N/A] Plotting related features are demonstrated in an example (documentation-only change) [N/A] New Features and API Changes are noted with a directive and release note (minor doc improvement) Documentation complies with general and docstring guidelines
Open Graph Description: PR summary This PR improves the documentation for FFMpegFileWriter by clarifying what parameters can be passed via *args and **kwargs. Problem: The current documentation doesn't explain what ar...
X Description: PR summary This PR improves the documentation for FFMpegFileWriter by clarifying what parameters can be passed via *args and **kwargs. Problem: The current documentation doesn't explain wha...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/30820
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:10c24866-402f-3821-b6ae-9ad9a8a7dff9 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | B86C:2D0224:1401606:1B2ACF9:6A521946 |
| html-safe-nonce | 2935c34a4ef44cfcae6dcf631ca24fa1867fd0b3c98d5cc7895b2ef25f2d057c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCODZDOjJEMDIyNDoxNDAxNjA2OjFCMkFDRjk6NkE1MjE5NDYiLCJ2aXNpdG9yX2lkIjoiNzk4NDc4NTMwMjQ4NDAzMTgxNSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 04360585312b825aa2f82d5ea4f4ed99639ac1b47857f47e2f43deb71348887c |
| hovercard-subject-tag | pull_request:3079258700 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/matplotlib/matplotlib/pull/30820/files |
| twitter:image | https://avatars.githubusercontent.com/u/145997182?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/145997182?s=400&v=4 |
| og:image:alt | PR summary This PR improves the documentation for FFMpegFileWriter by clarifying what parameters can be passed via *args and **kwargs. Problem: The current documentation doesn't explain what ar... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 7aed05249554b889eb33d002851a973eebcc7e91 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width