Cleanup animation docs. #16218

anntzer · 2020-01-14T11:00:20Z

PR Summary

PR Checklist

Has Pytest style unit tests
Code is Flake 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

timhoffm · 2020-01-14T20:04:45Z

lib/matplotlib/animation.py

-    fig : `~matplotlib.figure.Figure`
-       The figure object that is used to get draw, resize, and any
-       other needed events.
+    fig : `~.Figure`


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)

I don't agree with that policy, but let's put that discussion to another time. Reverted.

timhoffm · 2020-01-14T20:08:24Z

lib/matplotlib/animation.py

+        other needed events.
+    interval : int, default: 200
+        Delay between frames in milliseconds.
+    repeat_delay : int, default: None


Suggested change

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.

timhoffm · 2020-01-14T20:12:01Z

lib/matplotlib/animation.py

+        other needed events.
+    interval : int, default: 200
+        Delay between frames in milliseconds.
+    repeat_delay : int, default: None
        If the animation in repeated, adds a delay in milliseconds


Suggested change

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.

agreed (modulo wording)

timhoffm · 2020-01-14T20:13:38Z

lib/matplotlib/animation.py

+        the corresponding frame.  Other artists are made invisible.
+    interval : int, default: 200
+        Delay between frames in milliseconds.
+    repeat_delay : int, default: None


See repeat_delay comments above.

timhoffm · 2020-01-14T20:14:18Z

lib/matplotlib/animation.py

-    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


See repeat_delay comments above.

NelleV

👍
LGTM

NelleV · 2020-01-15T10:12:21Z

lib/matplotlib/animation.py

-        Controls whether blitting is used to optimize drawing.  Defaults
-        to ``False``.
-
+        The figure object that is used to get draw, resize, and any


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)

NelleV · 2020-01-15T10:12:59Z

lib/matplotlib/animation.py

-       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


NelleV · 2020-01-15T10:13:48Z

lib/matplotlib/animation.py

@@ -1550,23 +1535,23 @@ class FuncAnimation(TimedAnimation):
    Parameters
    ----------
    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


NelleV · 2020-01-15T10:15:20Z

lib/matplotlib/animation.py

-       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.


nitpick as well. You removed Controls for the blit argument. It would make sense to remove it here as well.

anntzer · 2020-01-15T10:29:15Z

Agreed with all. Additionally also slightly reworded AbstractMovieWriter.setup and inherited MovieWriter.setup from it.

NelleV · 2020-01-15T12:26:29Z

Thanks @anntzer !

anntzer added the Documentation label Jan 14, 2020

timhoffm reviewed Jan 14, 2020

View reviewed changes

anntzer force-pushed the adoc branch 2 times, most recently from 12bcd51 to 6309dbb Compare January 14, 2020 23:11

anntzer added the topic: animation label Jan 14, 2020

anntzer mentioned this pull request Jan 14, 2020

Make Animation.repeat_delay an int, not an int-or-None. #16227

Merged

6 tasks

NelleV approved these changes Jan 15, 2020

View reviewed changes

Cleanup animation docs.

e958ea7

anntzer force-pushed the adoc branch from 6309dbb to e958ea7 Compare January 15, 2020 10:28

NelleV merged commit 6ee361b into matplotlib:master Jan 15, 2020

anntzer deleted the adoc branch January 15, 2020 12:42

QuLogic added this to the v3.3.0 milestone Feb 12, 2020

	repeat_delay : int, default: None
	repeat_delay : int, default: 0

	If the animation in repeated, adds a delay in milliseconds
	If the animation is repeated, adds a delay in milliseconds

Uh oh!

Cleanup animation docs. #16218

Cleanup animation docs. #16218

Uh oh!

Conversation

anntzer commented Jan 14, 2020

PR Summary

PR Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NelleV left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anntzer commented Jan 15, 2020

Uh oh!

NelleV commented Jan 15, 2020

Uh oh!

Uh oh!