From 11a0e6b52e4cc773076aa97844f490a92064d086 Mon Sep 17 00:00:00 2001 From: Alejandro Dubrovsky Date: Sun, 7 Apr 2013 22:59:25 +1000 Subject: [PATCH 1/2] Clarify documentation for FuncAnimation --- lib/matplotlib/animation.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py index de2d17a30eae..3d1f399ac397 100644 --- a/lib/matplotlib/animation.py +++ b/lib/matplotlib/animation.py @@ -952,7 +952,10 @@ class FuncAnimation(TimedAnimation): *init_func* is a function used to draw a clear frame. If not given, the results of drawing from the first item in the frames sequence will be - used. + used. This function will be called once before the first frame. + + If blit=True, *func* and *init_func* should return a list of drawables to + clear. ''' def __init__(self, fig, func, frames=None, init_func=None, fargs=None, save_count=None, **kwargs): From 644aac64b5f740ada91a6906bce7bd54b8397c7e Mon Sep 17 00:00:00 2001 From: Alejandro Dubrovsky Date: Sun, 7 Apr 2013 23:06:58 +1000 Subject: [PATCH 2/2] more FuncAnimation documentation tweaking --- lib/matplotlib/animation.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py index 3d1f399ac397..63f8727c9e32 100644 --- a/lib/matplotlib/animation.py +++ b/lib/matplotlib/animation.py @@ -954,8 +954,8 @@ class FuncAnimation(TimedAnimation): results of drawing from the first item in the frames sequence will be used. This function will be called once before the first frame. - If blit=True, *func* and *init_func* should return a list of drawables to - clear. + If blit=True, *func* and *init_func* should return an iterable of + drawables to clear. ''' def __init__(self, fig, func, frames=None, init_func=None, fargs=None, save_count=None, **kwargs):