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 873d393

Browse filesBrowse files
NelleVtacaswell
authored andcommitted
Merge pull request #7035 from JuliaSprenger/master
DOC Update semilogy docstring to numpy doc format
1 parent 7ed77e4 commit 873d393
Copy full SHA for 873d393

File tree

Expand file treeCollapse file tree

1 file changed

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

1 file changed

+24
-25
lines changed

‎lib/matplotlib/axes/_axes.py

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

0 commit comments

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