Deprecate some label-related attributes on ContourLabeler. #24144
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
The deprecated attributes cannot be updated after the ContourLabeler has been set up (i.e. if the end user overwrites them it does not update the labels) *and* all have direct replacements available. We could consider later adding new getters/setters (`get/set_font_properties`) which would actually update the properties on the label texts. While at it, prefer using `manual` over the equivalent but longer `self.labelManual`; `_get_nth_label_width` doesn't need to explicitly set the text size as that info is also carried by the fontproperties object.
timhoffm
approved these changes
Oct 14, 2022
oscargus
approved these changes
Oct 15, 2022
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.
The deprecated attributes cannot be updated after the ContourLabeler has been set up (i.e. if the end user overwrites them it does not update the labels) and all have direct replacements available. We could consider later adding new getters/setters (
get/set_font_properties) which would actually update the properties on the label texts.While at it, prefer using
manualover the equivalent but longerself.labelManual;_get_nth_label_widthdoesn't need to explicitly set the text size as that info is also carried by the fontproperties object.PR Summary
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).