Skip to content
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.

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

Docstring for ArtistAnimation is incorrect #6964

Closed
typograph opened this issue Aug 22, 2016 · 1 comment
Closed

Docstring for ArtistAnimation is incorrect #6964

typograph opened this issue Aug 22, 2016 · 1 comment
Assignees
Milestone

Comments

@typograph
Copy link

The docstring for the ArtistAnimation class mentions frame_info, although the argument to the constructor is called artists. I would suggest changing the argument name back to frame_info, as artists makes one think this should be a simple collection.

@dopplershift
Copy link
Contributor

Changing the name of the parameter would technically be an API break, since someone could be passing it as a keyword argument. I'd be happy to take a Pull Request to fix the docstring and change frame_info to *artists* (asterisks should be there as well since it's documenting the method parameter).

@dopplershift dopplershift self-assigned this Aug 22, 2016
@tacaswell tacaswell added this to the 2.0.1 (next bug fix release) milestone Aug 23, 2016
dopplershift added a commit to dopplershift/matplotlib that referenced this issue Sep 7, 2016
dopplershift added a commit to dopplershift/matplotlib that referenced this issue Sep 7, 2016
@QuLogic QuLogic modified the milestones: 2.0 (style change major release), 2.0.1 (next bug fix release) Dec 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants