Merge pull request matplotlib#24863 from dstansby/polartransform-param-doc

Add parameter doc to PolarTransform

Author: timhoffm

lib/matplotlib/projections/polar.py

@@ -31,6 +31,17 @@ class PolarTransform(mtransforms.Transform):
 
     def __init__(self, axis=None, use_rmin=True,
                  _apply_theta_transforms=True):
+        """
+        Parameters
+        ----------
+        axis : `~matplotlib.axis.Axis`, optional
+            Axis associated with this transform. This is used to get the
+            minimum radial limit.
+        use_rmin : `bool`, optional
+            If ``True``, subtract the minimum radial axis limit before
+            transforming to Cartesian coordinates. *axis* must also be
+            specified for this to take effect.
+        """
         super().__init__()
         self._axis = axis
         self._use_rmin = use_rmin
@@ -171,6 +182,17 @@ class InvertedPolarTransform(mtransforms.Transform):
 
     def __init__(self, axis=None, use_rmin=True,
                  _apply_theta_transforms=True):
+        """
+        Parameters
+        ----------
+        axis : `~matplotlib.axis.Axis`, optional
+            Axis associated with this transform. This is used to get the
+            minimum radial limit.
+        use_rmin : `bool`, optional
+            If ``True`` add the minimum radial axis limit after
+            transforming from Cartesian coordinates. *axis* must also be
+            specified for this to take effect.
+        """
         super().__init__()
         self._axis = axis
         self._use_rmin = use_rmin