Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 80e37d9

Browse files
dstansbyMeeseeksDev[bot]
authored and
MeeseeksDev[bot]
committed
Backport PR #14261: Updated polar documentation
1 parent 364f452 commit 80e37d9

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

lib/matplotlib/projections/polar.py

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1022,6 +1022,16 @@ def get_thetamin(self):
10221022
return np.rad2deg(self.viewLim.xmin)
10231023

10241024
def set_thetalim(self, *args, **kwargs):
1025+
"""
1026+
Set the minimum and maximum theta values.
1027+
1028+
Parameters
1029+
----------
1030+
thetamin : float
1031+
Minimum value in degrees.
1032+
thetamax : float
1033+
Maximum value in degrees.
1034+
"""
10251035
if 'thetamin' in kwargs:
10261036
kwargs['xmin'] = np.deg2rad(kwargs.pop('thetamin'))
10271037
if 'thetamax' in kwargs:
@@ -1100,21 +1110,59 @@ def get_theta_direction(self):
11001110
return self._direction.get_matrix()[0, 0]
11011111

11021112
def set_rmax(self, rmax):
1113+
"""
1114+
Set the outer radial limit.
1115+
1116+
Parameters
1117+
----------
1118+
rmax : float
1119+
"""
11031120
self.viewLim.y1 = rmax
11041121

11051122
def get_rmax(self):
1123+
"""
1124+
Returns
1125+
-------
1126+
float
1127+
Outer radial limit.
1128+
"""
11061129
return self.viewLim.ymax
11071130

11081131
def set_rmin(self, rmin):
1132+
"""
1133+
Set the inner radial limit.
1134+
1135+
Parameters
1136+
----------
1137+
rmin : float
1138+
"""
11091139
self.viewLim.y0 = rmin
11101140

11111141
def get_rmin(self):
1142+
"""
1143+
Returns
1144+
-------
1145+
float
1146+
The inner radial limit.
1147+
"""
11121148
return self.viewLim.ymin
11131149

11141150
def set_rorigin(self, rorigin):
1151+
"""
1152+
Update the radial origin.
1153+
1154+
Parameters
1155+
----------
1156+
rorigin : float
1157+
"""
11151158
self._originViewLim.locked_y0 = rorigin
11161159

11171160
def get_rorigin(self):
1161+
"""
1162+
Returns
1163+
-------
1164+
float
1165+
"""
11181166
return self._originViewLim.y0
11191167

11201168
def get_rsign(self):

0 commit comments

Comments
 (0)