Skip to content

Doc animation #7589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 12, 2016
Merged

Doc animation #7589

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
80d8dd8
DOC: partially numpydoc-ify animation module
tacaswell Dec 7, 2016
24c7aad
DOC: use auto summary in animation_api.rst
tacaswell Dec 8, 2016
e465fb7
DOC: start to add animation prose
tacaswell Dec 8, 2016
ff1e71e
DOC: address comments
tacaswell Dec 11, 2016
55017cd
DOC: re-work MovieWriter section a bit
tacaswell Dec 11, 2016
1a6c61c
DOC: address the rest of the comments
tacaswell Dec 11, 2016
8e8291c
DOC: Fix more typos and minor errors
tacaswell Dec 11, 2016
4c4779b
DOC: minor tweaks
tacaswell Dec 12, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
DOC: minor tweaks
  • Loading branch information
@tacaswell
tacaswell committed Dec 12, 2016
commit 4c4779b3e6812b7e277debe7c8f95fbe709da5d1
8 changes: 4 additions & 4 deletions lib/matplotlib/animation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1199,7 +1199,7 @@ 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`.

repeat : bool, optional
Controls whether the animation should repeat when the sequence
Expand Down Expand Up @@ -1279,9 +1279,9 @@ class ArtistAnimation(TimedAnimation):
other needed events.

artists : list
With each list entry a collection of artists that
represent what needs to be enabled on each frame. These will
be disabled for other frames.
Each list entry a collection of artists that represent what
needs to be enabled on each frame. These will be disabled for
other frames.

interval : number, optional
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broader question: Do we need to repeat the documentation of attributes from the base class?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was intentional because having to chase through base classes to understand parameters is a bit rough. In the case of most artist we have no option (and/or use that table), but in this case it is a small enough bunch the duplication isn't bad.

It is also rough because not all of the parameters from the base-classes can be passed to the sub-classes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, you've convinced me.

Delay between frames in milliseconds. Defaults to 200.
Expand Down