Update stackplot docs for legend capabilities

dmcdougall · dmcdougall · commit 6a2258c83c35 · 2013-06-21T21:09:53.000-05:00
The docs now state that creation of a proxy artist is the preferred method for
creating legends on stackplots.  This is because stackplot creates
PolyCollection objects which are not supported by the legend
diff --git a/lib/matplotlib/stackplot.py b/lib/matplotlib/stackplot.py
@@ -43,6 +43,11 @@ def stackplot(axes, x, *args, **kwargs):
     Returns *r* : A list of
     :class:`~matplotlib.collections.PolyCollection`, one for each
     element in the stacked area plot.
+
+    Note that :class:`~matplotlib.legend.Legend` does not support
+    :class:`~matplotlib.collections.PolyCollection` objects.  To create a
+    legend on a stackplot, use a proxy artist:
+    http://matplotlib.org/users/legend_guide.html#using-proxy-artist
     """
 
     if len(args) == 1:
