Add references to backend_{gtk3,gtk4,wx} in docs. #25457
Merged
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
These modules are not actual backends but rather serve as bases for the corresponding agg/cairo backends, but adding them to the docs allows referring to them from elsewhere. Note that backend_qt is already listed; _backend_tk is currently private but we could consider making it (or a subset of it) public like the others (I already rely on it in mplcairo, for example).
|
Without looking - how well explained are the differences between these and the full backends? These almost should be called something else? |
|
There's currently really no docs for either the bases or the full backends in the API docs (e.g. https://matplotlib.org/stable/api/backend_gtk4_api.html), so as not to require the GUI toolkits to be present when building the docs. So in general better documentation would be nice, but that'd be a much bigger project than just adding entries like this PR does. |
jklymak
approved these changes
Mar 14, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Mar 14, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Mar 14, 2023
ksunden
added a commit
that referenced
this pull request
Mar 14, 2023
…457-on-v3.7.x Backport PR #25457 on branch v3.7.x (Add references to backend_{gtk3,gtk4,wx} in docs.)
ksunden
added a commit
that referenced
this pull request
Mar 14, 2023
…457-on-v3.7.1-doc Backport PR #25457 on branch v3.7.1-doc (Add references to backend_{gtk3,gtk4,wx} in docs.)
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.
These modules are not actual backends but rather serve as bases for the corresponding agg/cairo backends, but adding them to the docs allows referring to them from elsewhere.
Note that backend_qt is already listed; _backend_tk is currently private but we could consider making it (or a subset of it) public like the others (I already rely on it in mplcairo, for example).
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