DOC: add_child_axes to axes_api.rst #12347
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
ImportanceOfBeingErnest
approved these changes
Sep 30, 2018
There was a problem hiding this comment.
I think all methods should be documented. If there is reason for the user not to use a method, its docstrings should simply state it like this ("Note that this method should only be used in rare cases. To create schalala in wololo, use the .schalawolo method instead.")
I would hence approve this (modulo doc tests passing).
anntzer
approved these changes
Sep 30, 2018
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 30, 2018
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 30, 2018
QuLogic
added a commit
that referenced
this pull request
Sep 30, 2018
…347-on-v3.0.x Backport PR #12347 on branch v3.0.x (DOC: add_child_axes to axes_api.rst)
QuLogic
added a commit
that referenced
this pull request
Sep 30, 2018
…347-on-v3.0.0-doc Backport PR #12347 on branch v3.0.0-doc (DOC: add_child_axes to axes_api.rst)
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
As above, the doctoring for
add_child_axeswasn't in the docs. OTOH I can see an argument for it not to be, i.e. not private, but not so public...PR Checklist