8000 Update some mplot3d docs. · matplotlib/matplotlib@25fdf0a · GitHub
[go: up one dir, main page]

Skip to content

Commit 25fdf0a

Browse files
committed
Update some mplot3d docs.
Mostly removing "This function was added, but not tested" when codecov indicates that the function is actually covered by CI (it may still not be *directly* tested, but that's the case of a bunch of APIs and we don't bother with peppering their docstrings with such statements). The get_zbound docstring is adapted from the one of get_xbound.
1 parent 3bacb5f commit 25fdf0a

File tree

1 file changed

+2
-9
lines changed

1 file changed

+2
-9
lines changed

lib/mpl_toolkits/mplot3d/axes3d.py

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1295,8 +1295,7 @@ def grid(self, b=True, **kwargs):
12951295
:meth:`matplotlib.axes.Axes.grid`, but it is intended to
12961296
eventually support that behavior.
12971297
1298-
.. versionchanged :: 1.1.0
1299-
This function was changed, but not tested. Please report any bugs.
1298+
.. versionadded :: 1.1.0
13001299
'''
13011300
# TODO: Operate on each axes separately
13021301
if len(kwargs):
@@ -1411,7 +1410,6 @@ def tick_params(self, axis='both', **kwargs):
14111410
those who file bugs.
14121411
14131412
.. versionadded :: 1.1.0
1414-
This function was added, but not tested. Please report any bugs.
14151413
"""
14161414
cbook._check_in_list(['x', 'y', 'z', 'both'], axis=axis)
14171415
if axis in ['x', 'y', 'both']:
@@ -1441,19 +1439,15 @@ def zaxis_inverted(self):
14411439
Returns True if the z-axis is inverted.
14421440
14431441
.. versionadded :: 1.1.0
1444-
This function was added, but not tested. Please report any bugs.
14451442
'''
14461443
bottom, top = self.get_zlim()
14471444
return top < bottom
14481445

14491446
def get_zbound(self):
14501447
"""
1451-
Returns the z-axis numerical bounds where::
1452-
1453-
lowerBound < upperBound
1448+
Return the lower and upper z-axis bounds, in increasing order.
14541449
14551450
.. versionadded :: 1.1.0
1456-
This function was added, but not tested. Please report any bugs.
14571451
"""
14581452
bottom, top = self.get_zlim()
14591453
if bottom < top:
@@ -1468,7 +1462,6 @@ def set_zbound(self, lower=None, upper=None):
14681462
It will not change the :attr:`_autoscaleZon` attribute.
14691463
14701464
.. versionadded :: 1.1.0
1471-
This function was added, but not tested. Please report any bugs.
14721465
"""
14731466
if upper is None and np.iterable(lower):
14741467
lower, upper = lower

0 commit comments

Comments
 (0)
0