Prefer projection="polar" over polar=True.

anntzer · anntzer · commit b60dd14436a4 · 2021-02-11T22:00:27.000+01:00
... per dev call.

The docstring of add_axes/add_subplot still needs to be changed, but
this should wait until after projection reuse behavior is finalized.

Also, cases of polar=True in the tests have been left as such, to keep
exercising that API.
diff --git a/examples/pie_and_polar_charts/nested_pie.py b/examples/pie_and_polar_charts/nested_pie.py
@@ -52,7 +52,7 @@
 # a circle. The cumulative sum of the values are used as the edges
 # of the bars.
 
-fig, ax = plt.subplots(subplot_kw=dict(polar=True))
+fig, ax = plt.subplots(subplot_kw=dict(projection="polar"))
 
 size = 0.3
 vals = np.array([[60., 32.], [37., 40.], [29., 10.]])
diff --git a/examples/pie_and_polar_charts/polar_scatter.py b/examples/pie_and_polar_charts/polar_scatter.py
@@ -33,7 +33,7 @@
 # rotate the plot.
 
 fig = plt.figure()
-ax = fig.add_subplot(polar=True)
+ax = fig.add_subplot(projection='polar')
 c = ax.scatter(theta, r, c=colors, s=area, cmap='hsv', alpha=0.75)
 
 ax.set_rorigin(-2.5)
@@ -47,7 +47,7 @@
 # theta start and end limits, producing a sector instead of a full circle.
 
 fig = plt.figure()
-ax = fig.add_subplot(polar=True)
+ax = fig.add_subplot(projection='polar')
 c = ax.scatter(theta, r, c=colors, s=area, cmap='hsv', alpha=0.75)
 
 ax.set_thetamin(45)
diff --git a/examples/pyplots/annotation_polar.py b/examples/pyplots/annotation_polar.py
@@ -12,7 +12,7 @@
 import matplotlib.pyplot as plt
 
 fig = plt.figure()
-ax = fig.add_subplot(polar=True)
+ax = fig.add_subplot(projection='polar')
 r = np.arange(0, 1, 0.001)
 theta = 2 * 2*np.pi * r
 line, = ax.plot(theta, r, color='#ee8d18', lw=3)
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -813,7 +813,7 @@ def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
             ax2.scatter(x, y)
 
             # Create four polar Axes and access them through the returned array
-            axes = fig.subplots(2, 2, subplot_kw=dict(polar=True))
+            axes = fig.subplots(2, 2, subplot_kw=dict(projection='polar'))
             axes[0, 0].plot(x, y)
             axes[1, 1].scatter(x, y)
 
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1360,7 +1360,7 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
         ax2.scatter(x, y)
 
         # Create four polar axes and access them through the returned array
-        fig, axs = plt.subplots(2, 2, subplot_kw=dict(polar=True))
+        fig, axs = plt.subplots(2, 2, subplot_kw=dict(projection="polar"))
         axs[0, 0].plot(x, y)
         axs[1, 1].scatter(x, y)
 
@@ -2426,7 +2426,7 @@ def polar(*args, **kwargs):
         else:
             _api.warn_external('Trying to create polar plot on an Axes '
                                'that does not have a polar projection.')
-    ax = axes(polar=True)
+    ax = axes(projection="polar")
     ret = ax.plot(*args, **kwargs)
     return ret
 
