Remove individual doc entries for some methods Axes inherits from Artist #19025
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 methods are directly inherited, so don't need a separate doc entry.
timhoffm
approved these changes
Nov 27, 2020
There was a problem hiding this comment.
I don't have a clear view how to reasonably handle inherited methods so that they are still reasonably discoverable (IIRC there's a separate discussion somewhere).
For this particular case however, it's reasonable to not list the given methods. get/set_contains is deprecated anyway, and I suppose there's little need for picking an Axes. It's better to remove them to reduce clutter.
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 methods are directly inherited, so don't need a separate doc entry. (See #14960 for a longer discussion of a similar case.)
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).