Skip to content

Commit b3a92c2

Browse files
committed
DOC: Add [*Discouraged*] prefix to summary lines
Apply matplotlib#29303 where it was missing
1 parent 3aebcb7 commit b3a92c2

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

lib/matplotlib/axes/_base.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3602,7 +3602,7 @@ def set_xlabel(self, xlabel, fontdict=None, labelpad=None, *,
36023602

36033603
def invert_xaxis(self):
36043604
"""
3605-
Invert the x-axis.
3605+
[*Discouraged*] Invert the x-axis.
36063606
36073607
.. admonition:: Discouraged
36083608
@@ -3621,13 +3621,14 @@ def invert_xaxis(self):
36213621
get_xinverted = _axis_method_wrapper("xaxis", "get_inverted")
36223622
xaxis_inverted = _axis_method_wrapper("xaxis", "get_inverted")
36233623
if xaxis_inverted.__doc__:
3624-
xaxis_inverted.__doc__ += textwrap.dedent("""
3624+
xaxis_inverted.__doc__ = ("[*Discouraged*] " + xaxis_inverted.__doc__ +
3625+
textwrap.dedent("""
36253626
36263627
.. admonition:: Discouraged
36273628
36283629
The use of this method is discouraged.
36293630
Use `.Axes.get_xinverted` instead.
3630-
""")
3631+
"""))
36313632

36323633
def get_xbound(self):
36333634
"""
@@ -3870,7 +3871,7 @@ def set_ylabel(self, ylabel, fontdict=None, labelpad=None, *,
38703871

38713872
def invert_yaxis(self):
38723873
"""
3873-
Invert the y-axis.
3874+
[*Discouraged*] Invert the y-axis.
38743875
38753876
.. admonition:: Discouraged
38763877
@@ -3889,13 +3890,14 @@ def invert_yaxis(self):
38893890
get_yinverted = _axis_method_wrapper("yaxis", "get_inverted")
38903891
yaxis_inverted = _axis_method_wrapper("yaxis", "get_inverted")
38913892
if yaxis_inverted.__doc__:
3892-
yaxis_inverted.__doc__ += textwrap.dedent("""
3893+
yaxis_inverted.__doc__ = ("[*Discouraged*] " + yaxis_inverted.__doc__ +
3894+
textwrap.dedent("""
38933895
38943896
.. admonition:: Discouraged
38953897
38963898
The use of this method is discouraged.
38973899
Use `.Axes.get_yinverted` instead.
3898-
""")
3900+
"""))
38993901

39003902
def get_ybound(self):
39013903
"""

lib/matplotlib/axis.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1443,7 +1443,7 @@ def set_label(self, s):
14431443

14441444
def get_label(self):
14451445
"""
1446-
Return the axis label as a Text instance.
1446+
[*Discouraged*] Return the axis label as a Text instance.
14471447
14481448
.. admonition:: Discouraged
14491449

lib/mpl_toolkits/mplot3d/axes3d.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1886,7 +1886,7 @@ def tick_params(self, axis='both', **kwargs):
18861886

18871887
def invert_zaxis(self):
18881888
"""
1889-
Invert the z-axis.
1889+
[*Discouraged*] Invert the z-axis.
18901890
18911891
.. admonition:: Discouraged
18921892
@@ -1906,13 +1906,14 @@ def invert_zaxis(self):
19061906
get_zinverted = _axis_method_wrapper("zaxis", "get_inverted")
19071907
zaxis_inverted = _axis_method_wrapper("zaxis", "get_inverted")
19081908
if zaxis_inverted.__doc__:
1909-
zaxis_inverted.__doc__ += textwrap.dedent("""
1909+
zaxis_inverted.__doc__ = ("[*Discouraged*] " + zaxis_inverted.__doc__ +
1910+
textwrap.dedent("""
19101911
19111912
.. admonition:: Discouraged
19121913
19131914
The use of this method is discouraged.
19141915
Use `.Axes3D.get_zinverted` instead.
1915-
""")
1916+
"""))
19161917

19171918
def get_zbound(self):
19181919
"""

0 commit comments

Comments
 (0)