Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: add_child_axes to axes_api.rst #12347

Merged
merged 1 commit into from Sep 30, 2018

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Sep 30, 2018

PR Summary

As above, the doctoring for add_child_axes wasn'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

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

Copy link
Member

@ImportanceOfBeingErnest ImportanceOfBeingErnest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 anntzer merged commit 0d8c6f8 into matplotlib:master 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
@jklymak jklymak deleted the doc-add-child-axis branch September 30, 2018 14:34
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants