8000 Remove versionadded and versionchanged notes · matplotlib/matplotlib@9488d1c · GitHub
[go: up one dir, main page]
Skip to content

Commit 9488d1c

Browse files
KentKent
Kent
authored and
Kent
committed
Remove versionadded and versionchanged notes
1 parent 2e248f5 commit 9488d1c

File tree

1 file changed

+0
-83
lines changed

1 file changed

+0
-83
lines changed

‎lib/mpl_toolkits/mplot3d/axes3d.py

Lines changed: 0 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,6 @@ def convert_zunits(self, z):
171171
"""
172172
For artists in an axes, if the zaxis has units support,
173173
convert *z* using zaxis unit type
174-
175-
.. versionadded:: 1.2.1
176-
177174
"""
178175
return self.zaxis.convert_units(z)
179176

@@ -539,28 +536,19 @@ def update_datalim(self, xys, **kwargs):
539536
def get_autoscale_on(self):
540537
"""
541538
Get whether autoscaling is applied for all axes on plot commands
542-
543-
.. versionadded:: 1.1.0
544-
This function was added, but not tested. Please report any bugs.
545539
"""
546540
return super().get_autoscale_on() and self.get_autoscalez_on()
547541

548542
def get_autoscalez_on(self):
549543
"""
550544
Get whether autoscaling for the z-axis is applied on plot commands
551-
552-
.. versionadded:: 1.1.0
553-
This function was added, but not tested. Please report any bugs.
554545
"""
555546
return self._autoscaleZon
556547

557548
def set_autoscale_on(self, b):
558549
"""
559550
Set whether autoscaling is applied on plot commands
560551
561-
.. versionadded:: 1.1.0
562-
This function was added, but not tested. Please report any bugs.
563-
564552
Parameters
565553
----------
566554
b : bool
@@ -572,8 +560,6 @@ def set_autoscalez_on(self, b):
572560
"""
573561
Set whether autoscaling for the z-axis is applied on plot commands
574562
575-
.. versionadded:: 1.1.0
576-
577563
Parameters
578564
----------
579565
b : bool
@@ -606,8 +592,6 @@ def set_zmargin(self, m):
606592
end of that interval before it is used in autoscaling.
607593
608594
accepts: float in range 0 to 1
609-
610-
.. versionadded:: 1.1.0
611595
"""
612596
if m < 0 or m > 1:
613597
raise ValueError("margin must be in range 0 to 1")
@@ -652,8 +636,6 @@ def margins(self, *margins, x=None, y=None, z=None, tight=True):
652636
if *xmargin* is not None, then *xmargin* times the X data
653637
interval will be added to each end of that interval before
654638
it is used in autoscaling.
655-
656-
.. versionadded:: 1.1.0
657639
"""
658640
if margins and x is not None and y is not None and z is not None:
659641
raise TypeError('Cannot pass both positional and keyword '
@@ -690,8 +672,6 @@ def autoscale(self, enable=True, axis='both', tight=None):
690672
Note that this function behaves the same, but for all
691673
three axes. Therefore, 'z' can be passed for *axis*,
692674
and 'both' applies to all three axes.
693-
694-
.. versionadded:: 1.1.0
695675
"""
696676
if enable is None:
697677
scalex = True
@@ -747,13 +727,6 @@ def autoscale_view(self, tight=None, scalex=True, scaley=True,
747727
See :meth:`matplotlib.axes.Axes.autoscale_view` for documentation.
748728
Note that this function applies to the 3D axes, and as such
749729
adds the *scalez* to the function arguments.
750-
751-
.. versionchanged:: 1.1.0
752-
Function signature was changed to better match the 2D version.
753-
*tight* is now explicitly a kwarg and placed first.
754-
755-
.. versionchanged:: 1.2.1
756-
This is now fully functional.
757730
"""
758731
# This method looks at the rectangular volume (see above)
759732
# of data and decides how to scale the view portal to fit it.
@@ -987,20 +960,10 @@ def set_zlim3d(self, bottom=None, top=None, emit=True, auto=False,
987960
def get_xlim3d(self):
988961
return tuple(self.xy_viewLim.intervalx)
989962
get_xlim3d.__doc__ = maxes.Axes.get_xlim.__doc__
990-
if get_xlim3d.__doc__ is not None:
991-
get_xlim3d.__doc__ += """
992-
.. versionchanged:: 1.1.0
993-
This function now correctly refers to the 3D x-limits
994-
"""
995963

996964
def get_ylim3d(self):
997965
return tuple(self.xy_viewLim.intervaly)
998966
get_ylim3d.__doc__ = maxes.Axes.get_ylim.__doc__
999-
if get_ylim3d.__doc__ is not None:
1000-
get_ylim3d.__doc__ += """
1001-
.. versionchanged:: 1.1.0
1002-
Th 9E7A is function now correctly refers to the 3D y-limits.
1003-
"""
1004967

1005968
def get_zlim3d(self):
1006969
"""Get 3D z limits."""
@@ -1377,9 +1340,6 @@ def set_zlabel(self, zlabel, fontdict=None, labelpad=None, **kwargs):
13771340
def get_zlabel(self):
13781341
"""
13791342
Get the z-label text string.
1380-
1381-
.. versionadded:: 1.1.0
1382-
This function was added, but not tested. Please report any bugs.
13831343
"""
13841344
label = self.zaxis.get_label()
13851345
return label.get_text()
@@ -1410,8 +1370,6 @@ def grid(self, b=True, **kwargs):
14101370
Currently, this function does not behave the same as
14111371
:meth:`matplotlib.axes.Axes.grid`, but it is intended to
14121372
eventually support that behavior.
1413-
1414-
.. versionadded:: 1.1.0
14151373
"""
14161374
# TODO: Operate on each axes separately
14171375
if len(kwargs):
@@ -1429,9 +1387,6 @@ def locator_params(self, axis='both', tight=None, **kwargs):
14291387
parameters being set for all three axes. Also, *axis*
14301388
can also take a value of 'z' to apply parameters to the
14311389
z axis.
1432-
1433-
.. versionadded:: 1.1.0
1434-
This function was added, but not tested. Please report any bugs.
14351390
"""
14361391
_x = axis in ['x', 'both']
14371392
_y = axis in ['y', 'both']
@@ -1465,8 +1420,6 @@ def tick_params(self, axis='both', **kwargs):
14651420
14661421
.. note::
14671422
Axes3D currently ignores some of these settings.
1468-
1469-
.. versionadded:: 1.1.0
14701423
"""
14711424
_api.check_in_list(['x', 'y', 'z', 'both'], axis=axis)
14721425
if axis in ['x', 'y', 'both']:
@@ -1484,27 +1437,20 @@ def tick_params(self, axis='both', **kwargs):
14841437
def invert_zaxis(self):
14851438
"""
14861439
Invert the z-axis.
1487-
1488-
.. versionadded:: 1.1.0
1489-
This function was added, but not tested. Please report any bugs.
14901440
"""
14911441
bottom, top = self.get_zlim()
14921442
self.set_zlim(top, bottom, auto=None)
14931443

14941444
def zaxis_inverted(self):
14951445
"""
14961446
Returns True if the z-axis is inverted.
1497-
1498-
.. versionadded:: 1.1.0
14991447
"""
15001448
bottom, top = self.get_zlim()
15011449
return top < bottom
15021450

15031451
def get_zbound(self):
15041452
"""
15051453
Return the lower and upper z-axis bounds, in increasing order.
1506-
1507-
.. versionadded:: 1.1.0
15081454
"""
15091455
bottom, top = self.get_zlim()
15101456
if bottom < top:
@@ -1518,8 +1464,6 @@ def set_zbound(self, lower=None, upper=None):
15181464
15191465
This method will honor axes inversion regardless of parameter order.
15201466
It will not change the autoscaling setting (`.get_autoscalez_on()`).
1521-
1522-
.. versionadded:: 1.1.0
15231467
"""
15241468
if upper is None and np.iterable(lower):
15251469
lower, upper = lower
@@ -1627,8 +1571,6 @@ def plot_surface(self, X, Y, Z, *args, norm=None, vmin=None,
16271571
data is larger, it will be downsampled (by slicing) to these
16281572
numbers of points. Defaults to 50.
16291573
1630-
.. versionadded:: 2.0
1631-
16321574
rstride, cstride : int
16331575
Downsampling stride in each direction. These arguments are
16341576
mutually exclusive with *rcount* and *ccount*. If only one of
@@ -1885,8 +1827,6 @@ def plot_wireframe(self, X, Y, Z, *args, **kwargs):
18851827
not sampled in the corresponding direction, producing a 3D line
18861828
plot rather than a wireframe plot. Defaults to 50.
18871829
1888-
.. versionadded:: 2.0
1889-
18901830
rstride, cstride : int
18911831
Downsampling stride in each direction. These arguments are
18921832
mutually exclusive with *rcount* and *ccount*. If only one of
@@ -2033,8 +1973,6 @@ def plot_trisurf(self, *args, color=None, norm=None, vmin=None, vmax=None,
20331973
--------
20341974
.. plot:: gallery/mplot3d/trisurf3d.py
20351975
.. plot:: gallery/mplot3d/trisurf3d_2.py
2036-
2037-
.. versionadded:: 1.2.0
20381976
"""
20391977

20401978
had_data = self.has_data()
@@ -2196,9 +2134,6 @@ def tricontour(self, *args,
21962134
"""
21972135
Create a 3D contour plot.
21982136
2199-
.. versionchanged:: 1.3.0
2200-
Added support for custom triangulations
2201-
22022137
.. note::
22032138
This method currently produces incorrect output due to a
22042139
longstanding bug in 3D PolyCollection rendering.
@@ -2263,11 +2198,6 @@ def contourf(self, X, Y, Z, *args, zdir='z', offset=None, **kwargs):
22632198
Returns
22642199
-------
22652200
matplotlib.contour.QuadContourSet
2266-
2267-
Notes
2268-
-----
2269-
.. versionadded:: 1.1.0
2270-
The *zdir* and *offset* parameters.
22712201
"""
22722202
had_data = self.has_data()
22732203

@@ -2304,13 +2234,6 @@ def tricontourf(self, *args, zdir='z', offset=None, **kwargs):
23042234
Returns
23052235
-------
23062236
matplotlib.tri.tricontour.TriContourSet
2307-
2308-
Notes
2309-
-----
2310-
.. versionadded:: 1.1.0
2311-
The *zdir* and *offset* parameters.
2312-
.. versionchanged:: 1.3.0
2313-
Added support for custom triangulations
23142237
"""
23152238
had_data = self.has_data()
23162239

@@ -2818,8 +2741,6 @@ def voxels(self, *args, facecolors=None, edgecolors=None, shade=True,
28182741
``filled[0, 0, 0]`` placed with its lower corner at the origin.
28192742
Occluded faces are not plotted.
28202743
2821-
.. versionadded:: 2.1
2822-
28232744
Parameters
28242745
----------
28252746
filled : 3D np.array of bool
@@ -2854,13 +2775,9 @@ def voxels(self, *args, facecolors=None, edgecolors=None, shade=True,
28542775
Whether to shade the facecolors. Shading is always disabled when
28552776
*cmap* is specified.
28562777
2857-
.. versionadded:: 3.1
2858-
28592778
lightsource : `~matplotlib.colors.LightSource`
28602779
The lightsource to use when *shade* is True.
28612780
2862-
.. versionadded:: 3.1
2863-
28642781
**kwargs
28652782
Additional keyword arguments to pass onto
28662783
`~mpl_toolkits.mplot3d.art3d.Poly3DCollection`.

0 commit comments

Comments
 (0)
0