Skip to content

DOC: Document state of PieContainer - #32353

Open
timhoffm wants to merge 1 commit into
matplotlib:mainfrom
timhoffm:doc-piecontainer
Open

timhoffm wants to merge 1 commit into
matplotlib:mainfrom
timhoffm:doc-piecontainer

Conversation

@timhoffm

Copy link
Copy Markdown
Member

PR summary

as discussed in #32320 (comment)

AI Disclosure

no AI

PR quality check

  • Use an expressive title, e.g. "Fix title font property precedence"
  • N/A: New and changed code is tested
  • N/A: Plotting related features are demonstrated in an example
  • N/A: New features and API changes have release notes
  • Documentation complies with general and docstring guidelines

@jklymak jklymak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

.. versionadded:: 3.11

.. warning::
Limited guaranteed public API:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't that what we mean by provisional API?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The inverse: If we'd say "PieContainer is provisional", there would be no guarantee. We here guarantee a minimal set of API.

Note that the "provisional statement" below only covers the naming.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants