Rename stem parameters to be clearer.

QuLogic · QuLogic · commit 4cd53fe6027f · 2020-08-05T21:13:22.000-04:00
They are no longer x/y when using a different orientation. Also, this
should fix the unit conversion to use the correct Acis.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -2727,23 +2727,28 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None, bottom=0,
         """
         Create a stem plot.
 
-        A stem plot plots vertical lines at each *x* location from the baseline
-        to *y*, and places a marker there.
+        A stem plot draws lines perpendicular to a baseline at each location
+        *locs* from the baseline to *heads*, and places a marker there. For
+        horizontal stem plots (the default), the *locs* are *x* positions, and
+        the *heads* are *y* values. For vertical stem plots, the *locs* are
+        *y* positions, and the *heads* are *x* values.
 
         Call signature::
 
-          stem([x,] y, linefmt=None, markerfmt=None, basefmt=None)
+          stem([locs,] heads, linefmt=None, markerfmt=None, basefmt=None)
 
-        The x-positions are optional. The formats may be provided either as
-        positional or as keyword-arguments.
+        The *locs*-positions are optional. The formats may be provided either
+        as positional or as keyword-arguments.
 
         Parameters
         ----------
-        x : array-like, optional
-            The x-positions of the stems. Default: (0, 1, ..., len(y) - 1).
+        locs : array-like, default: (0, 1, ..., len(heads) - 1)
+            For horizontal stem plots, the x-positions of the stems.
+            For vertical stem plots, the y-positions of the stems.
 
-        y : array-like
-            The y-values of the stem heads.
+        heads : array-like
+            For horizontal stem plots, the y-values of the stem heads.
+            For vertical stem plots,  the x-values of the stem heads.
 
         linefmt : str, optional
             A string defining the properties of the vertical lines. Usually,
@@ -2774,7 +2779,7 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None, bottom=0,
         basefmt : str, default: 'C3-' ('C2-' in classic mode)
             A format string defining the properties of the baseline.
 
-        orientation : string, optional (horizontal)
+        orientation : str, default: 'horizontal'
             If 'vertical', will produce a vertically-oriented stem plot,
             else it will produce a horizontally-oriented stem plot.
 
@@ -2811,15 +2816,20 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None, bottom=0,
                              orientation=orientation)
 
         if len(args) == 1:
-            y, = args
-            x = np.arange(len(y))
+            heads, = args
+            locs = np.arange(len(heads))
             args = ()
         else:
-            x, y, *args = args
+            locs, heads, *args = args
 
-        self._process_unit_info(xdata=x, ydata=y)
-        x = self.convert_xunits(x)
-        y = self.convert_yunits(y)
+        if orientation == 'horizontal':
+            self._process_unit_info(xdata=locs, ydata=heads)
+            locs = self.convert_xunits(locs)
+            heads = self.convert_yunits(heads)
+        else:
+            self._process_unit_info(xdata=heads, ydata=locs)
+            heads = self.convert_xunits(heads)
+            locs = self.convert_yunits(locs)
 
         # defaults for formats
         if linefmt is None:
@@ -2868,16 +2878,14 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None, bottom=0,
         else:
             basestyle, basemarker, basecolor = _process_plot_format(basefmt)
 
-        # Check if the user wants a vertical stem plot
-        if orientation == 'vertical':
-            x, y = y, x
-
         # New behaviour in 3.1 is to use a LineCollection for the stemlines
         if use_line_collection:
             if orientation == 'vertical':
-                stemlines = [((bottom, yi), (xi, yi)) for xi, yi in zip(x, y)]
+                stemlines = [
+                    ((bottom, li), (hi, li)) for li, hi in zip(locs, heads)]
             else:
-                stemlines = [((xi, bottom), (xi, yi)) for xi, yi in zip(x, y)]
+                stemlines = [
+                    ((li, bottom), (li, hi)) for li, hi in zip(locs, heads)]
             if linestyle is None:
                 linestyle = rcParams['lines.linestyle']
             stemlines = mcoll.LineCollection(stemlines, linestyles=linestyle,
@@ -2887,28 +2895,35 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None, bottom=0,
         # Old behaviour is to plot each of the lines individually
         else:
             stemlines = []
-            for xi, yi in zip(x, y):
+            for li, hi in zip(locs, heads):
                 if orientation == 'vertical':
-                    xs = [bottom, xi]
-                    ys = [yi, yi]
+                    xs = [bottom, hi]
+                    ys = [li, li]
                 else:
-                    xs = [xi, xi]
-                    ys = [bottom, yi]
+                    xs = [li, li]
+                    ys = [bottom, hi]
                 l, = self.plot(xs, ys,
                                color=linecolor, linestyle=linestyle,
                                marker=linemarker, label="_nolegend_")
                 stemlines.append(l)
 
-        markerline, = self.plot(x, y, color=markercolor, linestyle=markerstyle,
-                                marker=markermarker, label="_nolegend_")
+        if orientation == 'vertical':
+            markerline, = self.plot(heads, locs, color=markercolor,
+                                    linestyle=markerstyle, marker=markermarker,
+                                    label="_nolegend_")
+        else:
+            markerline, = self.plot(locs, heads, color=markercolor,
+                                    linestyle=markerstyle, marker=markermarker,
+                                    label="_nolegend_")
 
         if orientation == 'vertical':
-            x, y = y, x
-            baseline, = self.plot([bottom, bottom], [np.min(x), np.max(x)],
+            baseline, = self.plot([bottom, bottom],
+                                  [np.min(locs), np.max(locs)],
                                   color=basecolor, linestyle=basestyle,
                                   marker=basemarker, label="_nolegend_")
         else:
-            baseline, = self.plot([np.min(x), np.max(x)], [bottom, bottom],
+            baseline, = self.plot([np.min(locs), np.max(locs)],
+                                  [bottom, bottom],
                                   color=basecolor, linestyle=basestyle,
                                   marker=basemarker, label="_nolegend_")
 
