Various TextPath cleanups. #13180
Merged
Various TextPath cleanups. #13180
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
6eac817 to
f844286
Compare
|
#13173 is merged, so this can go forward. |
In TextToPath.get_text_path, deprecate the usetex parameter in favor of
a tristate ismath={False, True, "TeX"}, which is consistent with all
other low-level text handling APIs (at the renderer level). (TextToPath
methods should be considered as low-level APIs; the main high-level API
is TextPath.)
Deprecate `TextPath.text_get_vertices_codes` and `TextPath.is_math_text`
which are clearly helper functions for the main constructor.
Moreover, previously, if TextPath was called with `usetex=False` and
`rcParams["text.usetex"]` == True, then `TextPath.is_math_text` would
return "TeX" as the ismath flag, which would then be interpreted as a
True ismath value (but not a True usetex value(!)) by
TextToPath.get_text_path. The new implementation avoids that problem.
Remove a nonexistent parameter from the docs of
RendererBase._get_text_path_transform.
|
done |
timhoffm
approved these changes
Feb 8, 2019
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Feb 23, 2019
|
The appveyor failure was an installation issue. |
QuLogic
added a commit
that referenced
this pull request
Feb 23, 2019
…180-on-v3.1.x Backport PR #13180 on branch v3.1.x (Various TextPath cleanups.)
6 tasks
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
In TextToPath.get_text_path, deprecate the usetex parameter in favor of
a tristate ismath={False, True, "TeX"}, which is consistent with all
other low-level text handling APIs (at the renderer level). (TextToPath
methods should be considered as low-level APIs; the main high-level API
is TextPath.)
Deprecate
TextPath.text_get_vertices_codesandTextPath.is_math_textwhich are clearly helper functions for the main constructor.
Moreover, previously, if TextPath was called with
usetex=FalseandrcParams["text.usetex"]== True, thenTextPath.is_math_textwouldreturn "TeX" as the ismath flag, which would then be interpreted as a
True ismath value (but not a True usetex value(!)) by
TextToPath.get_text_path. The new implementation avoids that problem.
Remove a nonexistent parameter from the docs of
RendererBase._get_text_path_transform.
Goes on top of #13173 (because of the use of the _delete_parameter decorator); so you may want to just review the last commit.
PR Checklist