8000 Deprecate clear_temp param/attr of FileMovieWriter. by anntzer · Pull Request #16092 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Deprecate clear_temp param/attr of FileMovieWriter. #16092

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

Jump to bottom
Merged
merged 2 commits into from
Feb 11, 2020
Merged

Deprecate clear_temp param/attr of FileMovieWriter. #16092

merged 2 commits into from
Feb 11, 2020

Conversation

anntzer
Copy link
Contributor
@anntzer anntzer commented Jan 4, 2020

It overlaps in awkward ways with frame_prefix, which effectively
provides the same functionality.

followup to #16082.

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

@dopplershift
Copy link
Contributor

Failing CI for some reason.

@timhoffm
Copy link
Member
timhoffm commented Jan 4, 2020

Failing CI for this reason:

/home/circleci/project/doc/api/_as_gen/matplotlib.animation.AVConvFileWriter.rst:39:<autosummary>:1: WARNING: py:obj reference target not found: matplotlib.animation.AVConvFileWriter.clear_temp
/home/circleci/project/lib/matplotlib/animation.py:docstring of matplotlib.animation.FFMpegFileWriter.supported_formats:1:<autosummary>:1: WARNING: py:obj reference target not found: matplotlib.animation.FFMpegFileWriter.clear_temp
/home/circleci/project/lib/matplotlib/animation.py:docstring of matplotlib.animation.ImageMagickFileWriter.supported_formats:1:<autosummary>:1: WARNING: py:obj reference target not found: matplotlib.animation.ImageMagickFileWriter.clear_temp

@anntzer
Copy link
Contributor Author
anntzer commented Jan 5, 2020

That's basically because the animation api docs autosummary is somehow configured to list all properties too (and clear_temp is now one of them, but has no docs). Updated missing-references.json.

@anntzer anntzer force-pushed the anim-cleartemp branch 5 times, most recently from 9f57f14 to 4e39196 Compare January 11, 2020 22:30
@anntzer
Deprecate clear_temp param/attr of FileMovieWriter.
9b8ec70 
It overlaps in awkward ways with frame_prefix, which effectively
provides the same functionality.
@anntzer
Copy link
Contributor Author
anntzer commented Feb 11, 2020

@dopplershift @timhoffm both of you approved; this should be good to go?

@anntzer anntzer added this to the v3.3.0 milestone Feb 11, 2020
@timhoffm timhoffm merged commit 2699c70 into matplotlib:master Feb 11, 2020
@anntzer anntzer deleted the anim-cleartemp branch February 11, 2020 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dopplershift dopplershift dopplershift approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
topic: animation
Projects
None yet
Milestone
v3.3.0
Development

Successfully merging this pull request may close these issues.
3 participants
@anntzer @dopplershift @timhoffm
0