Deprecate Axes3D.plot_surface(shade=None)

timhoffm · timhoffm · commit 3bd268dff397 · 2018-10-07T19:08:14.000+02:00
diff --git a/doc/api/next_api_changes/2018-10-07-TH-deprecations.rst b/doc/api/next_api_changes/2018-10-07-TH-deprecations.rst
@@ -0,0 +1,8 @@
+Deprecations
+````````````
+
+The following keyword arguments are deprecated:
+
+- Passing ``shade=None`` to `.Axes3D.plot_surface` is deprecated. This was
+  an unintended implementation detail with the same semantics as
+  ``shade=False``. Please use the latter code instead.
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -1651,6 +1651,12 @@ def plot_surface(self, X, Y, Z, *args, norm=None, vmin=None,
 
         cmap = kwargs.get('cmap', None)
         shade = kwargs.pop('shade', cmap is None)
+        if shade is None:
+            cbook.warn_deprecated(
+                "3.1",
+                "Passing shade=None to Axes3D.plot_surface() is deprecated "
+                "since matplotlib 3.1 and will change its semantic or raise "
+                "an error in matplotlib 3.3. Please use shade=False instead.")
 
         # evenly spaced, and including both endpoints
         row_inds = list(range(0, rows-1, rstride)) + [rows-1]
