Merge pull request #12442 from anntzer/drawstyle-linestyle

jklymak · web-flow · commit 3d4e78b08f89 · 2018-10-26T12:44:42.000-07:00
Deprecate passing drawstyle with linestyle as single string.
diff --git a/doc/api/api_changes/2018-10-08-AL-deprecations.rst b/doc/api/api_changes/2018-10-08-AL-deprecations.rst
@@ -0,0 +1,5 @@
+Passing a Line2D's drawstyle together with the linestyle is deprecated
+``````````````````````````````````````````````````````````````````````
+
+Instead of ``plt.plot(..., linestyle="steps--")``, use ``plt.plot(...,
+linestyle="--", drawstyle="steps")``. ``ds`` is now an alias for ``drawstyle``.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -2048,8 +2048,7 @@ def step(self, x, y, *args, where='pre', **kwargs):
         if where not in ('pre', 'post', 'mid'):
             raise ValueError("'where' argument to step must be "
                              "'pre', 'post' or 'mid'")
-        kwargs['linestyle'] = 'steps-' + where + kwargs.get('linestyle', '')
-
+        kwargs['drawstyle'] = 'steps-' + where
         return self.plot(x, y, *args, **kwargs)
 
     @_preprocess_data(replace_names=["x", "left",
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -207,6 +207,7 @@ def _slice_or_none(in_v, slc):
 @cbook._define_aliases({
     "antialiased": ["aa"],
     "color": ["c"],
+    "drawstyle": ["ds"],
     "linestyle": ["ls"],
     "linewidth": ["lw"],
     "markeredgecolor": ["mec"],
@@ -1133,6 +1134,13 @@ def _split_drawstyle_linestyle(self, ls):
         """
         for ds in self.drawStyleKeys:  # long names are first in the list
             if ls.startswith(ds):
+                cbook.warn_deprecated(
+                    "3.1", message="Passing the drawstyle with the linestyle "
+                    "as a single string is deprecated since Matplotlib "
+                    "%(since)s and support will be removed %(removal)s; "
+                    "please pass the drawstyle separately using the drawstyle "
+                    "keyword argument to Line2D or set_drawstyle() method (or "
+                    "ds/set_ds()).")
                 return ds, ls[len(ds):] or '-'
         return None, ls
 
