Skip to content

Commit bd02353

Browse files
committed
Document theta getters/setters
1 parent 85a96fb commit bd02353

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

lib/matplotlib/projections/polar.py

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -995,15 +995,43 @@ def _gen_axes_spines(self):
995995
return spines
996996

997997
def set_thetamax(self, thetamax):
998+
"""
999+
Set the maximum theta limit.
1000+
1001+
Parameters
1002+
----------
1003+
thetamax : float
1004+
Maximum theta limit in degrees.
1005+
"""
9981006
self.viewLim.x1 = np.deg2rad(thetamax)
9991007

10001008
def get_thetamax(self):
1009+
"""
1010+
Returns
1011+
-------
1012+
thetamax : float
1013+
Maximum theta limit in degrees.
1014+
"""
10011015
return np.rad2deg(self.viewLim.xmax)
10021016

10031017
def set_thetamin(self, thetamin):
1018+
"""
1019+
Set the minimum theta limit.
1020+
1021+
Parameters
1022+
----------
1023+
thetamin : float
1024+
Minimum theta limit in degrees.
1025+
"""
10041026
self.viewLim.x0 = np.deg2rad(thetamin)
10051027

10061028
def get_thetamin(self):
1029+
"""
1030+
Returns
1031+
-------
1032+
thetamin : float
1033+
Minimum theta limit in degrees.
1034+
"""
10071035
return np.rad2deg(self.viewLim.xmin)
10081036

10091037
def set_thetalim(self, *args, **kwargs):

0 commit comments

Comments
 (0)