Edit error messages for when metadata is passed to savefig
#25430
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
Closes matplotlib#25401 As requested, the error message is more related to what users are actually doing. Slight behavior change, though not sure it's worth a release note in that `imsave` will error if metadata is given for formats that don't support it (this was done because it was unused if it was passed, and if and when we add metadata support for those formats, it will be implemented in imsave)
anntzer
reviewed
Mar 11, 2023
| @@ -441,7 +441,9 @@ def buffer_rgba(self): | |||
| """ | |||
| return self.renderer.buffer_rgba() | |||
|
|
|||
| def print_raw(self, filename_or_obj): | |||
| def print_raw(self, filename_or_obj, metadata=None): | |||
tacaswell
approved these changes
Mar 14, 2023
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.
Closes #25401
As requested, the error message is more related to what users are
actually doing.
Slight behavior change, though not sure it's worth a release note in
that
imsavewill error if metadata is given for formats that don'tsupport it (this was done because it was unused if it was passed, and
if and when we add metadata support for those formats, it will be
implemented in imsave)
PR Summary
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst