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

Skip to content

DOC Update semilogy docstring to numpy doc format #7035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 14, 2016
Merged

DOC Update semilogy docstring to numpy doc format #7035

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8843ff4
DOC Update semilogy docstring to numpy doc format
JuliaSprenger Sep 5, 2016
e6a5b5b
DOC Removed trailing whitespaces
JuliaSprenger Sep 6, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 24 additions & 25 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1595,41 +1595,40 @@ def semilogx(self, *args, **kwargs):
# @_preprocess_data() # let 'plot' do the unpacking..
@docstring.dedent_interpd
def semilogy(self, *args, **kwargs):
"""
Make a plot with log scaling on the *y* axis.

call signature::

semilogy(*args, **kwargs)
r"""Make a plot with log scaling on the `y` axis.

:func:`semilogy` supports all the keyword arguments of
:func:`~matplotlib.pylab.plot` and
:meth:`matplotlib.axes.Axes.set_yscale`.

Notable keyword arguments:

*basey*: scalar > 1
Base of the *y* logarithm
Parameters
----------
basey : scalar > 1
Base of the `y` logarithm.

*subsy*: [ *None* | sequence ]
The location of the minor yticks; *None* defaults to
subsy : None or iterable
The location of the minor yticks. None defaults to
autosubs, which depend on the number of decades in the
plot; see :meth:`~matplotlib.axes.Axes.set_yscale` for
plot. See :meth:`~matplotlib.axes.Axes.set_yscale` for
details.

*nonposy*: [ 'mask' | 'clip' ]
Non-positive values in *y* can be masked as
invalid, or clipped to a very small positive number
nonposy : {'mask' | 'clip'} str
Non-positive values in `y` can be masked as
invalid, or clipped to a very small positive number.

The remaining valid kwargs are
:class:`~matplotlib.lines.Line2D` properties:
Returns
-------
`~matplotlib.lines.Line2D`
Line instance of the plot.

Other Parameters
----------------
kwargs : `~matplotlib.lines.Line2D` properties,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not kwargs; it's **kwargs (which should be documented as \*\*kwargs or enclosed in double-backticks (which I can't figure out how to use on GitHub without triggering the code styling.))

`~matplotlib.pylab.plot` and
`matplotlib.axes.Axes.set_yscale` arguments.

%(Line2D)s
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line2D probably also needs to be updated to get this interpolation correct.


.. seealso::
See also
--------
:meth:`loglog`: For example code and figure.

:meth:`loglog`
For example code and figure
"""
if not self._hold:
self.cla()
Expand Down