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 8843ff4

Browse filesBrowse files
committed
DOC Update semilogy docstring to numpy doc format
1 parent 5f553bc commit 8843ff4
Copy full SHA for 8843ff4

File tree

Expand file treeCollapse file tree

1 file changed

+25
-26
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+25
-26
lines changed

‎lib/matplotlib/axes/_axes.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_axes.py
+25-26Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1595,41 +1595,40 @@ def semilogx(self, *args, **kwargs):
15951595
# @_preprocess_data() # let 'plot' do the unpacking..
15961596
@docstring.dedent_interpd
15971597
def semilogy(self, *args, **kwargs):
1598-
"""
1599-
Make a plot with log scaling on the *y* axis.
1600-
1601-
call signature::
1602-
1603-
semilogy(*args, **kwargs)
1598+
r"""Make a plot with log scaling on the `y` axis.
16041599
1605-
:func:`semilogy` supports all the keyword arguments of
1606-
:func:`~matplotlib.pylab.plot` and
1607-
:meth:`matplotlib.axes.Axes.set_yscale`.
1608-
1609-
Notable keyword arguments:
1610-
1611-
*basey*: scalar > 1
1612-
Base of the *y* logarithm
1600+
Parameters
1601+
----------
1602+
basey : scalar > 1
1603+
Base of the `y` logarithm.
16131604
1614-
*subsy*: [ *None* | sequence ]
1615-
The location of the minor yticks; *None* defaults to
1605+
subsy : None or iterable
1606+
The location of the minor yticks. None defaults to
16161607
autosubs, which depend on the number of decades in the
1617-
plot; see :meth:`~matplotlib.axes.Axes.set_yscale` for
1608+
plot. See :meth:`~matplotlib.axes.Axes.set_yscale` for
16181609
details.
16191610
1620-
*nonposy*: [ 'mask' | 'clip' ]
1621-
Non-positive values in *y* can be masked as
1622-
invalid, or clipped to a very small positive number
1611+
nonposy : {'mask' | 'clip'} str
1612+
Non-positive values in `y` can be masked as
1613+
invalid, or clipped to a very small positive number.
16231614
1624-
The remaining valid kwargs are
1625-
:class:`~matplotlib.lines.Line2D` properties:
1615+
Returns
1616+
-------
1617+
`~matplotlib.lines.Line2D`
1618+
Line instance of the plot.
16261619
1627-
%(Line2D)s
1620+
Other Parameters
1621+
----------------
1622+
kwargs : `~matplotlib.lines.Line2D` properties,
1623+
`~matplotlib.pylab.plot` and
1624+
`matplotlib.axes.Axes.set_yscale` arguments.
16281625
1629-
.. seealso::
1626+
%(Line2D)s
16301627
1631-
:meth:`loglog`
1632-
For example code and figure
1628+
See also
1629+
--------
1630+
:meth:`loglog`: For example code and figure.
1631+
16331632
"""
16341633
if not self._hold:
16351634
self.cla()

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.