Merge pull request #28480 from meeseeksmachine/auto-backport-of-pr-28474-on-v3.9.x

QuLogic · web-flow · commit 452626f161ab · 2024-06-27T17:12:15.000-04:00
Backport PR #28474 on branch v3.9.x (Fix typing and docs for containers)
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -3527,11 +3527,11 @@ def errorbar(self, x, y, yerr=None, xerr=None,
         `.ErrorbarContainer`
             The container contains:
 
-            - plotline: `~matplotlib.lines.Line2D` instance of x, y plot markers
+            - data_line : A `~matplotlib.lines.Line2D` instance of x, y plot markers
               and/or line.
-            - caplines: A tuple of `~matplotlib.lines.Line2D` instances of the error
+            - caplines : A tuple of `~matplotlib.lines.Line2D` instances of the error
               bar caps.
-            - barlinecols: A tuple of `.LineCollection` with the horizontal and
+            - barlinecols : A tuple of `.LineCollection` with the horizontal and
               vertical error ranges.
 
         Other Parameters
diff --git a/lib/matplotlib/container.py b/lib/matplotlib/container.py
@@ -87,12 +87,12 @@ class ErrorbarContainer(Container):
     lines : tuple
         Tuple of ``(data_line, caplines, barlinecols)``.
 
-        - data_line : :class:`~matplotlib.lines.Line2D` instance of
-          x, y plot markers and/or line.
-        - caplines : tuple of :class:`~matplotlib.lines.Line2D` instances of
-          the error bar caps.
-        - barlinecols : list of :class:`~matplotlib.collections.LineCollection`
-          with the horizontal and vertical error ranges.
+        - data_line : A `~matplotlib.lines.Line2D` instance of x, y plot markers
+          and/or line.
+        - caplines : A tuple of `~matplotlib.lines.Line2D` instances of the error
+          bar caps.
+        - barlinecols : A tuple of `~matplotlib.collections.LineCollection` with the
+          horizontal and vertical error ranges.
 
     has_xerr, has_yerr : bool
         ``True`` if the errorbar has x/y errors.
@@ -115,13 +115,13 @@ class StemContainer(Container):
 
     Attributes
     ----------
-    markerline :  :class:`~matplotlib.lines.Line2D`
+    markerline : `~matplotlib.lines.Line2D`
         The artist of the markers at the stem heads.
 
-    stemlines : list of :class:`~matplotlib.lines.Line2D`
+    stemlines : `~matplotlib.collections.LineCollection`
         The artists of the vertical lines for all stems.
 
-    baseline : :class:`~matplotlib.lines.Line2D`
+    baseline : `~matplotlib.lines.Line2D`
         The artist of the horizontal baseline.
     """
     def __init__(self, markerline_stemlines_baseline, **kwargs):
@@ -130,7 +130,7 @@ def __init__(self, markerline_stemlines_baseline, **kwargs):
         ----------
         markerline_stemlines_baseline : tuple
             Tuple of ``(markerline, stemlines, baseline)``.
-            ``markerline`` contains the `.LineCollection` of the markers,
+            ``markerline`` contains the `.Line2D` of the markers,
             ``stemlines`` is a `.LineCollection` of the main lines,
             ``baseline`` is the `.Line2D` of the baseline.
         """
diff --git a/lib/matplotlib/container.pyi b/lib/matplotlib/container.pyi
@@ -34,12 +34,12 @@ class BarContainer(Container):
     ) -> None: ...
 
 class ErrorbarContainer(Container):
-    lines: tuple[Line2D, Line2D, LineCollection]
+    lines: tuple[Line2D, tuple[Line2D, ...], tuple[LineCollection, ...]]
     has_xerr: bool
     has_yerr: bool
     def __init__(
         self,
-        lines: tuple[Line2D, Line2D, LineCollection],
+        lines: tuple[Line2D, tuple[Line2D, ...], tuple[LineCollection, ...]],
         has_xerr: bool = ...,
         has_yerr: bool = ...,
         **kwargs
