diff --git a/doc/api/axes_api.rst b/doc/api/axes_api.rst index 2e94fa5f9d65..231e5be98ddf 100644 --- a/doc/api/axes_api.rst +++ b/doc/api/axes_api.rst @@ -607,3 +607,5 @@ Other Axes.get_transformed_clip_path_and_affine Axes.has_data Axes.set + +.. autoclass:: matplotlib.axes.Axes.ArtistList diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py index 301c1d546a39..185e7e231765 100644 --- a/lib/matplotlib/axes/_base.py +++ b/lib/matplotlib/axes/_base.py @@ -1315,8 +1315,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):