Deprecate MovieWriter.{exec,args}_key, making them private. #16095
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
d8b3e02 to
c6d27d9
Compare
timhoffm
approved these changes
Jan 4, 2020
There was a problem hiding this comment.
past CI.
Note: Doc build fails with
/home/circleci/project/lib/matplotlib/animation.py:docstring of matplotlib.animation.FileMovieWriter.cleanup:1:<autosummary>:1: WARNING: py:obj reference target not found: matplotlib.animation.FileMovieWriter.args_key
/home/circleci/project/lib/matplotlib/animation.py:docstring of matplotlib.animation.FileMovieWriter.cleanup:1:<autosummary>:1: WARNING: py:obj reference target not found: matplotlib.animation.FileMovieWriter.exec_key
|
I just added them to missing_references, as the args/exec_key were already listed there for subclasses, it looks like to be a spurious thing due to autosummary, and they are going away post-deprecation anyways. |
dopplershift
approved these changes
Jan 4, 2020
Builtin writer subclasses additionally define the _exec_key and _args_key attributes, which indicate the rcParams entries where the path to the executable and additional command-line arguments to the executable are stored. Third-party writers cannot meaningfully set these as they cannot extend rcParams with new keys. Hence they are really an internal way of mapping builtin writers to rcParams and should not be exposed.
40b2b7e to
7feeac2
Compare
|
rebased |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Builtin writer subclasses additionally define the _exec_key and
_args_key attributes, which indicate the rcParams entries where the
path to the executable and additional command-line arguments to the
executable are stored. Third-party writers cannot meaningfully set
these as they cannot extend rcParams with new keys.
Hence they are really an internal way of mapping builtin writers to
rcParams and should not be exposed.
Goes on top of #16081.
PR Checklist