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

Skip to content

Commit 6c5a44e

Browse files
committed
Convert get_xlim and get_ylim docstrings
1 parent a9f0a8f commit 6c5a44e

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

lib/matplotlib/axes/_base.py

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2783,7 +2783,19 @@ def set_xbound(self, lower=None, upper=None):
27832783

27842784
def get_xlim(self):
27852785
"""
2786-
Get the x-axis range [*left*, *right*]
2786+
Get the x-axis range
2787+
2788+
Returns
2789+
-------
2790+
xlimits : tuple
2791+
Returns the current x-axis limits as the tuple
2792+
(`left`, `right`).
2793+
2794+
Notes
2795+
-----
2796+
The x-axis may be inverted, in which case the `left` value will
2797+
be greater than the `right` value.
2798+
27872799
"""
27882800
return tuple(self.viewLim.intervalx)
27892801

@@ -3053,7 +3065,19 @@ def set_ybound(self, lower=None, upper=None):
30533065

30543066
def get_ylim(self):
30553067
"""
3056-
Get the y-axis range [*bottom*, *top*]
3068+
Get the y-axis range
3069+
3070+
Returns
3071+
-------
3072+
ylimits : tuple
3073+
Returns the current y-axis limits as the tuple
3074+
(`bottom`, `top`).
3075+
3076+
Notes
3077+
-----
3078+
The y-axis may be inverted, in which case the `bottom` value
3079+
will be greater than the `top` value.
3080+
30573081
"""
30583082
return tuple(self.viewLim.intervaly)
30593083

0 commit comments

Comments
 (0)