Fix deprecation messages for vendoring unused things #23711
Merged
+15
−15
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
tacaswell
approved these changes
Aug 23, 2022
timhoffm
reviewed
Aug 23, 2022
lib/matplotlib/__init__.py
Outdated
| @@ -436,7 +436,7 @@ def impl(args, regex, min_ver=None, ignore_exit_code=False): | |||
| raise ValueError("Unknown executable: {!r}".format(name)) | |||
|
|
|||
|
|
|||
| @_api.deprecated("3.6", alternative="Vendor the code") | |||
| @_api.deprecated("3.6", alternative="a vendored copy this function") | |||
There was a problem hiding this comment.
Suggested change
| @_api.deprecated("3.6", alternative="a vendored copy this function") | |
| @_api.deprecated("3.6", alternative="a vendored copy of this function") |
lib/matplotlib/testing/decorators.py
Outdated
| @@ -88,7 +88,7 @@ def wrapped_callable(*args, **kwargs): | |||
| return make_cleanup | |||
|
|
|||
|
|
|||
| @_api.deprecated("3.6", alternative="Vendor the existing code " | |||
| @_api.deprecated("3.6", alternative="a vendored copy of the existing code " | |||
| "of _check_freetype_version.") | |||
There was a problem hiding this comment.
Suggested change
| "of _check_freetype_version.") | |
| "of _check_freetype_version") |
lib/matplotlib/testing/decorators.py
Outdated
| @@ -45,7 +45,7 @@ def tearDownClass(cls): | |||
| cls._cm.__exit__(None, None, None) | |||
|
|
|||
|
|
|||
| @_api.deprecated("3.6", alternative="Vendor the existing code, " | |||
| @_api.deprecated("3.6", alternative="a vendored copy of the existing code, " | |||
| "including the private function _cleanup_cm.") | |||
There was a problem hiding this comment.
Suggested change
| "including the private function _cleanup_cm.") | |
| "including the private function _cleanup_cm") |
lib/matplotlib/testing/decorators.py
Outdated
| @@ -32,7 +32,7 @@ def _cleanup_cm(): | |||
| plt.close("all") | |||
|
|
|||
|
|
|||
| @_api.deprecated("3.6", alternative="Vendor the existing code, " | |||
| @_api.deprecated("3.6", alternative="a vendored copy of the existing code, " | |||
| "including the private function _cleanup_cm.") | |||
There was a problem hiding this comment.
Suggested change
| "including the private function _cleanup_cm.") | |
| "including the private function _cleanup_cm") |
Formerly, the deprecation message would say "Use Vendor the code instead"; now they say "Use a vendored copy of the code instead", etc.
624f588 to
65bbec0
Compare
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Aug 24, 2022
oscargus
added a commit
that referenced
this pull request
Aug 24, 2022
…711-on-v3.6.x Backport PR #23711 on branch v3.6.x (Fix deprecation messages for vendoring unused things)
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
Formerly, the deprecation message would say "Use Vendor the code instead"; now they say "Use a vendored copy of the code instead", etc.
This weird grammar can cause some confusion, cf #23244
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).