Cleanup animation docs.#16218
Conversation
| fig : `~matplotlib.figure.Figure` | ||
| The figure object that is used to get draw, resize, and any | ||
| other needed events. | ||
| fig : `~.Figure` |
There was a problem hiding this comment.
It is our current policy to use fully qualified names for argument types, see https://matplotlib.org/devdocs/devel/documenting_mpl.html#referencing-types.
(multiple occurrences throught the PR)
There was a problem hiding this comment.
I don't agree with that policy, but let's put that discussion to another time. Reverted.
| other needed events. | ||
| interval : int, default: 200 | ||
| Delay between frames in milliseconds. | ||
| repeat_delay : int, default: None |
There was a problem hiding this comment.
| repeat_delay : int, default: None | |
| repeat_delay : int, default: 0 |
That's what it semantically does. AFAICS we could even use 0 as the actual default value.
| interval : int, default: 200 | ||
| Delay between frames in milliseconds. | ||
| repeat_delay : int, default: None | ||
| If the animation in repeated, adds a delay in milliseconds |
There was a problem hiding this comment.
| If the animation in repeated, adds a delay in milliseconds | |
| If the animation is repeated, adds a delay in milliseconds |
But while we're at it, could be written as
The delay between subsequent runs of the animation, if it is repeated.
There was a problem hiding this comment.
agreed (modulo wording)
| the corresponding frame. Other artists are made invisible. | ||
| interval : int, default: 200 | ||
| Delay between frames in milliseconds. | ||
| repeat_delay : int, default: None |
There was a problem hiding this comment.
See repeat_delay comments above.
| repeat_delay : number, optional | ||
| If the animation in repeated, adds a delay in milliseconds | ||
| before repeating the animation. Defaults to *None*. | ||
| repeat_delay : int, default: None |
There was a problem hiding this comment.
See repeat_delay comments above.
12bcd51 to
6309dbb
Compare
| Controls whether blitting is used to optimize drawing. Defaults | ||
| to ``False``. | ||
|
|
||
| The figure object that is used to get draw, resize, and any |
There was a problem hiding this comment.
Nitpick. That sentence is awkward. How about:
The figure object used to get needed events, such as draw or resize.
(I'm still unhappy about the word get)
| The figure object that is used to get draw, resize, and any | ||
| other needed events. | ||
|
|
||
| The figure object that is used to get draw, resize, and any |
| fig : `~matplotlib.figure.Figure` | ||
| The figure object that is used to get draw, resize, and any | ||
| other needed events. | ||
| The figure object that is used to get draw, resize, and any |
| Controls whether frame data is cached. Defaults to *True*. | ||
| Disabling cache might be helpful when frames contain large objects. | ||
| cache_frame_data : bool, default: True | ||
| Controls whether frame data is cached. |
There was a problem hiding this comment.
nitpick as well. You removed Controls for the blit argument. It would make sense to remove it here as well.
|
Agreed with all. Additionally also slightly reworded AbstractMovieWriter.setup and inherited MovieWriter.setup from it. |
|
Thanks @anntzer ! |
PR Summary
PR Checklist