Merge pull request #9796 from QuLogic/polar-frac

dopplershift · web-flow · commit 7b0c82a59197 · 2017-11-20T12:33:35.000-07:00
Add deprecation for Axes.set_thetagrids(frac).
diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -111,13 +111,16 @@ negative values are simply used as labels, and the real radius is shifted by
 the configured minimum. This release also allows negative radii to be used for
 grids and ticks, which were previously silently ignored.
 
-Radial ticks have been modified to be parallel to the circular grid
-line, and angular ticks have been modified to be parallel to the grid
-line. It may also be useful to rotate tick *labels* to match the
-boundary. Calling ``ax.tick_params(rotation='auto')`` will enable the
-new behavior: radial tick labels will be parallel to the circular grid
-line, and angular tick labels will be perpendicular to the grid line
-(i.e., parallel to the outer boundary).
+Radial ticks have been modified to be parallel to the circular grid line, and
+angular ticks have been modified to be parallel to the grid line. It may also
+be useful to rotate tick *labels* to match the boundary. Calling
+``ax.tick_params(rotation='auto')`` will enable the new behavior: radial tick
+labels will be parallel to the circular grid line, and angular tick labels will
+be perpendicular to the grid line (i.e., parallel to the outer boundary).
+Additionally, tick labels now obey the padding settings that previously only
+worked on Cartesian plots. Consequently, the ``frac`` argument to
+`.PolarAxes.set_thetagrids` is no longer applied. Tick padding can be modified
+with the ``pad`` argument to `.Axes.tick_params` or `.Axis.set_tick_params`.
 
 
 ``Figure`` class now has ``subplots`` method
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -1173,6 +1173,11 @@ def set_thetagrids(self, angles, labels=None, frac=None, fmt=None,
 
         ACCEPTS: sequence of floats
         """
+        if frac is not None:
+            cbook.warn_deprecated('2.1', name='frac', obj_type='parameter',
+                                  alternative='tick padding via '
+                                              'Axes.tick_params')
+
         # Make sure we take into account unitized data
         angles = self.convert_yunits(angles)
         angles = np.asarray(angles, float)
