Skip to content

DOC: fix broken link in inset-locator example #11717

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

Merged
merged 1 commit into from
Jul 21, 2018

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Jul 20, 2018

PR Summary

Made a small error in #11026 with resolving a link in examples/axes_grid1/inset_locator_demo.py. I think this fixes it...

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 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

@jklymak jklymak added this to the v3.0 milestone Jul 20, 2018
# optionally a location (loc) which accepts locations as codes, similar to
# `~matplotlib.axes.Axes.legend`.
# By default, the inset is offset by some points from the axes - this is
# The `.inset_locator`'s `~mpl_toolkits.axes_grid1.inset_axes` allows

Choose a reason for hiding this comment

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

If I'm not mistaken it should be
~mpl_toolkits.axes_grid1.inset_locator.inset_axes, which may probably be shortened to ~inset_locator.inset_axes. So I guess I was the one to actually make this mistake when I last edited that example.

@jklymak
Copy link
Member Author

jklymak commented Jul 20, 2018

It worked before because ~.inset_axes was unique in the namespace, now there is Axes.inset_axes (on master).

@jklymak jklymak force-pushed the doc-fix-broken-link-il branch from 19d8be7 to 8661e9d Compare July 20, 2018 22:37
@ImportanceOfBeingErnest
Copy link
Member

...a quite unfortunate decision to name it exactly like the existing one.

@jklymak
Copy link
Member Author

jklymak commented Jul 20, 2018

The end goal is to deprecate axes_grid1, so I’m not concerned about the method having the same name. Same thing happened w twinx.

@jklymak jklymak force-pushed the doc-fix-broken-link-il branch from 8661e9d to dec1c0e Compare July 21, 2018 04:57
@dstansby dstansby merged commit 38476fd into matplotlib:master Jul 21, 2018
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.

3 participants