Clarify public-ness of some ToolContainerBase APIs. #28169
Merged
+27
−7
Conversation
This file contains 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
timhoffm
reviewed
May 4, 2024
lib/matplotlib/backend_bases.py
Outdated
Comment on lines
3417
to
3421
| Note | ||
| ---- | ||
| This method is not intended to be called by end-users (who should | ||
| instead `.ToolContainerBase.add_tool`); it is provided to be | ||
| implemented by third-party backends. |
There was a problem hiding this comment.
I would phrase the whole docstring differently:
A hook to add a toolitem to the container.
This hook must be implemented in each backend and contains the backend-specific
code to add a tool; e.g. add an element to the toolbar.
.. warning::
This is part of the backend implementation and should not be called by end-users.
They should instead call `.ToolContainerBase.add_tool`.
I intentionally deviated from the "Do something" summary line to set this apart from
regular methods that users will call to perform actions.
Also for the other cases.
add_toolitem is clearly intended as a helper for add_tool (add_tool sets up a bunch of auxiliary arguments for it which the end-user should not bother with). toggle_toolitem and remove_toolitem also look internal-ish. Document them as such.
timhoffm
approved these changes
May 5, 2024
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
May 5, 2024
tacaswell
added a commit
that referenced
this pull request
May 6, 2024
…169-on-v3.9.x Backport PR #28169 on branch v3.9.x (Clarify public-ness of some ToolContainerBase APIs.)
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.
add_toolitem is clearly intended as a helper for add_tool (add_tool sets up a bunch of auxiliary arguments for it which the end-user should not bother with). toggle_toolitem and remove_toolitem also look internal-ish. Document them as such.
Noted while looking at #28166.
PR summary
PR checklist