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]: Axes.inset_axes is still experimental #27648

Closed
rcomer opened this issue Jan 14, 2024 · 9 comments · Fixed by #27665
Closed

[Doc]: Axes.inset_axes is still experimental #27648

rcomer opened this issue Jan 14, 2024 · 9 comments · Fixed by #27665
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones!
Milestone

Comments

@rcomer
Copy link
Member

rcomer commented Jan 14, 2024

Documentation Link

https://matplotlib.org/devdocs/api/_as_gen/matplotlib.axes.Axes.inset_axes.html#matplotlib.axes.Axes.inset_axes

Problem

I just noticed that Axes.inset_axes is still marked as experimental. It seems pretty well established to me, even recommended as a method for placing colorbars.

Suggested improvement

Is it time to remove the "experimental" warning?

@Snehaaa18
Copy link

Please assign this issue to me

@rcomer
Copy link
Member Author

rcomer commented Jan 14, 2024

Hello @Snehaaa18, thank you for your enthusiasm, but we do not assign issues. Also I would like to wait for other maintainers to comment whether it should be done before anyone makes the change.

@timhoffm
Copy link
Member

I vote for dropping the experimental flag. The API is consistent and simple enough. And it's been around long enough that we can expect reasonable adoption so that any incompatible changes should better run through a deprecation cycle, whether we've still formally marked it as experimental or not.

@jklymak
Copy link
Member

jklymak commented Jan 14, 2024

There was talk of adding the ordinal locations to inset_axes. However I'm 99% certain that can be done in a backwards compatible way should someone want to do that.

@timhoffm
Copy link
Member

There was talk of adding the ordinal locations to inset_axes. However I'm 99% certain that can be done in a backwards compatible way should someone want to do that.

Yes it could. But I tend to not do it. You either don't have control over the size and margins of the inset, or the API get's really complex. I think keeping it to the an analogous API as Figure.add_axes() is good enough.

@rcomer rcomer added Good first issue Open a pull request against these issues if there are no active ones! and removed status: needs comment/discussion needs consensus on next step labels Jan 17, 2024
Copy link

Good first issue - notes for new contributors

This issue is suited to new contributors because it does not require understanding of the Matplotlib internals. To get started, please see our contributing guide.

We do not assign issues. Check the Development section in the sidebar for linked pull requests (PRs). If there are none, feel free to start working on it. If there is an open PR, please collaborate on the work by reviewing it rather than duplicating it in a competing PR.

If something is unclear, please reach out on any of our communication channels.

@rcomer
Copy link
Member Author

rcomer commented Jan 17, 2024

I think the work here is:

@ShivamPathak99
Copy link
Contributor

Working on it.

@story645
Copy link
Member

story645 commented Jan 18, 2024

@ShivamPathak99 you accidentally opened your pull request against @tacaswell 's fork of Matplotlib, so we can't merge it into main. Can you instead open your pull request against https://github.com/matplotlib/matplotlib?

https://matplotlib.org/devdocs/devel/contribute.html#open-a-pull-request-on-matplotlib

My guess is you may have forked Tom's fork instead of forking against matplotlib/matplotlib

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants