Re: [Matplotlib-users] FuncAnimation documentation problem

[Ryan M. <rm...@gm...>]

On Sat, Feb 8, 2014 at 10:48 AM, Alan G Isaac <ai...@am...> wrote:

> The documentation for FuncAnimation says
>
> http://matplotlib.org/api/animation_api.html#matplotlib.animation.FuncAnimation
>
>      Makes an animation by repeatedly calling a function func,
>      passing in (optional) arguments in fargs.
>
>      frames can be a generator, an iterable, or a number of frames.
>
> I do not think FuncAnimation can be understood from this
> documentation.  (At least, I did not understand it.)
> I think it should read:
>
>      Makes an animation by repeatedly calling a function `func`,
>      passing in a value from `frames` and any (optional) arguments in
> `fargs`.
>
>      `frames` can be a generator, an iterable, or an integer number of
> frames.
>      Passing `frames=n` for integer `n` is equivalent to passing
> `range(n)`.
>
> Does this seem correct?
>
> Thanks,
> Alan Isaac
>
> PS It would be nice if repeat accepted an integer number of repetitions.
>

That does sound correct to me. (I'll apologize for the broken English in
the docs).

Any chance you could file an issue, and maybe one on the repeat? (I agree
this would be nice to have).

Ryan

-- 
Ryan May
Graduate Research Assistant
School of Meteorology
University of Oklahoma