8000 Backport PR #9268: Fix documents of semilogx and semilogy. · matplotlib/matplotlib@4f26ff1 · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 4f26ff1

Browse files
dstansbyMeeseeksDev[bot]
authored andcommitted
Backport PR #9268: Fix documents of semilogx and semilogy.
1 parent 7ae781f commit 4f26ff1

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1631,40 +1631,45 @@ def semilogx(self, *args, **kwargs):
16311631
# @_preprocess_data() # let 'plot' do the unpacking..
16321632
@docstring.dedent_interpd
16331633
def semilogy(self, *args, **kwargs):
1634-
r"""Make a plot with log scaling on the `y` axis.
1634+
"""
1635+
Make a plot with log scaling on the *y* axis.
16351636
16361637
Parameters
16371638
----------
1638-
basey : scalar > 1
1639-
Base of the `y` logarithm.
1639+
basey : float, optional
1640+
Base of the *y* logarithm. The scalar should be larger
1641+
than 1.
16401642
1641-
subsy : None or iterable
1642-
The location of the minor yticks. None defaults to
1643+
subsy : array_like, optional
1644+
The location of the minor yticks; *None* defaults to
16431645
autosubs, which depend on the number of decades in the
1644-
plot. See :meth:`~matplotlib.axes.Axes.set_yscale` for
1646+
plot; see :meth:`~matplotlib.axes.Axes.set_yscale` for
16451647
details.
16461648
1647-
nonposy : {'mask' | 'clip'} str
1648-
Non-positive values in `y` can be masked as
1649+
nonposy : string, optional, {'mask', 'clip'}
1650+
Non-positive values in *y* can be masked as
16491651
invalid, or clipped to a very small positive number.
16501652
16511653
Returns
16521654
-------
1653-
`~matplotlib.lines.Line2D`
1654-
Line instance of the plot.
1655+
`~matplotlib.pyplot.plot`
1656+
Log-scaled plot on the *y* axis.
16551657
16561658
Other Parameters
16571659
----------------
16581660
**kwargs :
1659-
This function supports all the keyword arguments of
1660-
:func:`~matplotlib.pyplot.plot` and
1661-
:meth:`matplotlib.axes.Axes.set_xscale`.
1662-
1663-
Keyword arguments also control the
1664-
:class:`~matplotlib.lines.Line2D` properties:
1661+
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
1662+
properties:
16651663
16661664
%(Line2D)s
1665+
1666+
Notes
1667+
-----
1668+
This function supports all the keyword arguments of
1669+
:func:`~matplotlib.pyplot.plot` and
1670+
:meth:`matplotlib.axes.Axes.set_yscale`.
16671671
"""
1672+
16681673
if not self._hold:
16691674
self.cla()
16701675
d = {'basey': kwargs.pop('basey', 10),

0 commit comments

Comments
 (0)
0