Skip to content

Document ArtistList #22177

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

Merged
merged 1 commit into from
Jan 12, 2022
Merged

Document ArtistList #22177

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions doc/api/axes_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,3 +607,5 @@ Other
Axes.get_transformed_clip_path_and_affine
Axes.has_data
Axes.set

.. autoclass:: matplotlib.axes.Axes.ArtistList
8 changes: 6 additions & 2 deletions lib/matplotlib/axes/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1317,8 +1317,12 @@ class ArtistList(MutableSequence):
"""
A sublist of Axes children based on their type.

This exists solely to warn on modification. In the future, the
type-specific children sublists will be immutable tuples.
The type-specific children sublists will become immutable in
Matplotlib 3.7. Then, these artist lists will likely be replaced by
tuples. Use as if this is a tuple already.

This class exists only for the transition period to warn on the
deprecated modifcation of artist lists.
"""
def __init__(self, axes, prop_name, add_name,
valid_types=None, invalid_types=None):
Expand Down