From 3188a7bca89a193aff9d292d9eca3db3a03efcc0 Mon Sep 17 00:00:00 2001
From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Date: Mon, 10 Jan 2022 00:53:09 +0100
Subject: [PATCH] Document ArtistList
---
doc/api/axes_api.rst | 2 ++
lib/matplotlib/axes/_base.py | 8 ++++++--
2 files changed, 8 insertions(+), 2 deletions(-)
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 becae5f9ac2d..7442a3f26513 100644
--- a/lib/matplotlib/axes/_base.py
+++ b/lib/matplotlib/axes/_base.py
@@ -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):
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy