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

Skip to content

Commit c183584

Browse files
authored
Merge pull request #7035 from JuliaSprenger/master
DOC Update semilogy docstring to numpy doc format
2 parents 0309e38 + e6a5b5b commit c183584

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1604,41 +1604,40 @@ def semilogx(self, *args, **kwargs):
16041604
# @_preprocess_data() # let 'plot' do the unpacking..
16051605
@docstring.dedent_interpd
16061606
def semilogy(self, *args, **kwargs):
1607-
"""
1608-
Make a plot with log scaling on the *y* axis.
1609-
1610-
call signature::
1611-
1612-
semilogy(*args, **kwargs)
1607+
r"""Make a plot with log scaling on the `y` axis.
16131608
1614-
:func:`semilogy` supports all the keyword arguments of
1615-
:func:`~matplotlib.pylab.plot` and
1616-
:meth:`matplotlib.axes.Axes.set_yscale`.
1617-
1618-
Notable keyword arguments:
1619-
1620-
*basey*: scalar > 1
1621-
Base of the *y* logarithm
1609+
Parameters
1610+
----------
1611+
basey : scalar > 1
1612+
Base of the `y` logarithm.
16221613
1623-
*subsy*: [ *None* | sequence ]
1624-
The location of the minor yticks; *None* defaults to
1614+
subsy : None or iterable
1615+
The location of the minor yticks. None defaults to
16251616
autosubs, which depend on the number of decades in the
1626-
plot; see :meth:`~matplotlib.axes.Axes.set_yscale` for
1617+
plot. See :meth:`~matplotlib.axes.Axes.set_yscale` for
16271618
details.
16281619
1629-
*nonposy*: [ 'mask' | 'clip' ]
1630-
Non-positive values in *y* can be masked as
1631-
invalid, or clipped to a very small positive number
1620+
nonposy : {'mask' | 'clip'} str
1621+
Non-positive values in `y` can be masked as
1622+
invalid, or clipped to a very small positive number.
16321623
1633-
The remaining valid kwargs are
1634-
:class:`~matplotlib.lines.Line2D` properties:
1624+
Returns
1625+
-------
1626+
`~matplotlib.lines.Line2D`
1627+
Line instance of the plot.
1628+
1629+
Other Parameters
1630+
----------------
1631+
kwargs : `~matplotlib.lines.Line2D` properties,
1632+
`~matplotlib.pylab.plot` and
1633+
`matplotlib.axes.Axes.set_yscale` arguments.
16351634
16361635
%(Line2D)s
16371636
1638-
.. seealso::
1637+
See also
1638+
--------
1639+
:meth:`loglog`: For example code and figure.
16391640
1640-
:meth:`loglog`
1641-
For example code and figure
16421641
"""
16431642
if not self._hold:
16441643
self.cla()

0 commit comments

Comments
 (0)