Skip to content

DOC: Document state of PieContainer #32353

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.

Sign up for GitHub

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

Open
timhoffm wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −1
Open

DOC: Document state of PieContainer #32353

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion lib/matplotlib/container.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,11 +150,22 @@ def __init__(self, lines, has_xerr=False, has_yerr=False, **kwargs):

class PieContainer:
"""
Container for the artists of pie charts (e.g. created by `.Axes.pie`).
Preliminary aggregating class for the artists of pie charts (e.g. created by
`.Axes.pie`).

.. versionadded:: 3.11

.. warning::
Limited guaranteed public API:

@story645 story645 Sep 15, 2026

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?

@timhoffm timhoffm Sep 16, 2026

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.


- the below given attributes
- the methods ``remove()`` and ``add_texts()``
- tuple unpacking of the container into ``(wedges, texts)`` for backward
compatibility

This is currently not a `.Container`, it's still to be decided whether this
is promoted to a proper `.Container` or developed in a different direction.

The class name ``PieContainer`` name is provisional and may change in future
to reflect development of its functionality.

Expand Down
Loading