Animation doc markup cleanups. #9033
Conversation
731b401 to
5785aee
Compare
| metadata: dict of string:string or None | ||
| movie utility. The default is ``None``, which passes the additional | ||
| arguments in the ``animation.extra_args`` rcParam. | ||
| metadata: Dict[str, str] or None |
There was a problem hiding this comment.
I think dict of string:string benefits from being changed into Dict[str,str] but ... or None is so prevalent throughout the code base that such a change (if done) should be the object of another PR.
There was a problem hiding this comment.
You changed the one above, so I wasn't sure if you wanted to be consistent.
lib/matplotlib/animation.py
Outdated
| frames per second in the movie. Defaults to None, | ||
| which will use the animation's specified interval to set | ||
| the frames per second. | ||
| frames per second in the movie. Defaults to None, which will use the |
| @@ -1313,15 +1311,15 @@ class TimedAnimation(Animation): | |||
|
|
|||
| repeat_delay : number, optional | |||
| If the animation in repeated, adds a delay in milliseconds | |||
| before repeating the animation. Defaults to `None`. | |||
| before repeating the animation. Defaults to ``None``. | |||
There was a problem hiding this comment.
Remove extra space after period?
There was a problem hiding this comment.
I tend to prefer two spaces after a period (https://en.wikipedia.org/wiki/Sentence_spacing -- I know there are arguments both ways). I don't think it's worth changing the style throughout the docs, but at least locally it should be better to uniformize it (so here I settled towards two-spacing). Same reply applies to comments below.
|
|
||
| repeat : bool, optional | ||
| Controls whether the animation should repeat when the sequence | ||
| of frames is completed. Defaults to `True`. | ||
| of frames is completed. Defaults to ``True``. |
There was a problem hiding this comment.
Why add the extra space?
| @@ -1402,15 +1399,15 @@ class ArtistAnimation(TimedAnimation): | |||
|
|
|||
| repeat_delay : number, optional | |||
| If the animation in repeated, adds a delay in milliseconds | |||
| before repeating the animation. Defaults to `None`. | |||
| before repeating the animation. Defaults to ``None``. | |||
There was a problem hiding this comment.
Remove extra space after period?
|
|
||
| interval : number, optional | ||
| Delay between frames in milliseconds. Defaults to 200. | ||
|
|
||
| repeat_delay : number, optional | ||
| If the animation in repeated, adds a delay in milliseconds | ||
| before repeating the animation. Defaults to `None`. | ||
| before repeating the animation. Defaults to ``None``. |
|
|
||
| repeat : bool, optional | ||
| Controls whether the animation should repeat when the sequence | ||
| of frames is completed. Defaults to `True`. | ||
| of frames is completed. Defaults to ``True``. |
5785aee to
f5ee0bb
Compare
f5ee0bb to
cef5782
Compare
|
Waiting to see if we can get Travis green here... |
PR Summary
PR Checklist