Skip to content

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

Closed

Description

@rcomer

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?

Activity

  1. Snehaaa18 commented on Jan 14, 2024

    @Snehaaa18

    Please assign this issue to me

  2. rcomer commented on Jan 14, 2024

    @rcomer
    MemberAuthor

    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.

  3. timhoffm commented on Jan 14, 2024

    @timhoffm
    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.

  4. jklymak commented on Jan 14, 2024

    @jklymak
    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.

  5. timhoffm commented on Jan 14, 2024

    @timhoffm
    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.

  6. added
    🌱 Good first issueOpen a pull request against these issues if there are no active ones!
    and removed on Jan 17, 2024
  7. github-actions commented on Jan 17, 2024

    @github-actions

    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.

  8. rcomer commented on Jan 17, 2024

    @rcomer
    MemberAuthor

    I think the work here is:

  9. ShivamPathak99 commented on Jan 18, 2024

    @ShivamPathak99
    Contributor

    Working on it.

  10. story645 commented on Jan 18, 2024

    @story645
    Member

    @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

  11. added this to the v3.9.0 milestone on Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Documentation🌱 Good first issueOpen a pull request against these issues if there are no active ones!

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions