Skip to content

Commit 82bc35e

Browse files
authored
Merge pull request #7031 from DoriekeMG/doc_semilogx
DOC Replaced documentation with numpydoc for semilogx
2 parents 8ff57bb + eb12a6c commit 82bc35e

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1554,38 +1554,43 @@ def semilogx(self, *args, **kwargs):
15541554
"""
15551555
Make a plot with log scaling on the *x* axis.
15561556
1557-
Call signature::
1558-
1559-
semilogx(*args, **kwargs)
1560-
1561-
:func:`semilogx` supports all the keyword arguments of
1562-
:func:`~matplotlib.pyplot.plot` and
1563-
:meth:`matplotlib.axes.Axes.set_xscale`.
1564-
1565-
Notable keyword arguments:
1566-
1567-
*basex*: scalar > 1
1568-
Base of the *x* logarithm
1557+
Parameters
1558+
----------
1559+
basex : float, optional
1560+
Base of the *x* logarithm. The scalar should be larger
1561+
than 1.
15691562
1570-
*subsx*: [ *None* | sequence ]
1563+
subsx : array_like, optional
15711564
The location of the minor xticks; *None* defaults to
15721565
autosubs, which depend on the number of decades in the
15731566
plot; see :meth:`~matplotlib.axes.Axes.set_xscale` for
15741567
details.
15751568
1576-
*nonposx*: [ 'mask' | 'clip' ]
1569+
nonposx : string, optional, {'mask', 'clip'}
15771570
Non-positive values in *x* can be masked as
1578-
invalid, or clipped to a very small positive number
1571+
invalid, or clipped to a very small positive number.
15791572
1580-
The remaining valid kwargs are
1573+
Returns
1574+
-------
1575+
`~matplotlib.pyplot.plot`
1576+
Log-scaled plot on the *x* axis.
1577+
1578+
Other Parameters
1579+
----------------
15811580
:class:`~matplotlib.lines.Line2D` properties:
15821581
15831582
%(Line2D)s
15841583
1585-
.. seealso::
1584+
See Also
1585+
--------
1586+
loglog : For example code and figure.
1587+
1588+
Notes
1589+
-----
1590+
This function supports all the keyword arguments of
1591+
:func:`~matplotlib.pyplot.plot` and
1592+
:meth:`matplotlib.axes.Axes.set_xscale`.
15861593
1587-
:meth:`loglog`
1588-
For example code and figure
15891594
"""
15901595
if not self._hold:
15911596
self.cla()

0 commit comments

Comments
 (0)