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

Fix documents of semilogx and semilogy. #9268

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 1 commit into from
Oct 6, 2017
Merged

Fix documents of semilogx and semilogy. #9268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 21 additions & 16 deletions 37 lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1631,40 +1631,45 @@ def semilogx(self, *args, **kwargs):
# @_preprocess_data() # let 'plot' do the unpacking..
@docstring.dedent_interpd
def semilogy(self, *args, **kwargs):
r"""Make a plot with log scaling on the `y` axis.
"""
Copy link
Contributor

Choose a reason for hiding this comment

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

Although not crucial, it would be nice to take advantage of this opportunity to fix the docstring of semilogy to exactly match the one of semilogx, save for x/y. Right now there are a number of discrepancies.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have already fixed the docstring of semilogy to match the one of semilogx.

Make a plot with log scaling on the *y* axis.

Parameters
----------
basey : scalar > 1
Base of the `y` logarithm.
basey : float, optional
Base of the *y* logarithm. The scalar should be larger
than 1.

subsy : None or iterable
The location of the minor yticks. None defaults to
subsy : array_like, optional
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'} str
Non-positive values in `y` can be masked as
nonposy : string, optional, {'mask', 'clip'}
Non-positive values in *y* can be masked as
invalid, or clipped to a very small positive number.

Returns
-------
`~matplotlib.lines.Line2D`
Line instance of the plot.
`~matplotlib.pyplot.plot`
Log-scaled plot on the *y* axis.

Other Parameters
----------------
**kwargs :
This function supports all the keyword arguments of
:func:`~matplotlib.pyplot.plot` and
:meth:`matplotlib.axes.Axes.set_xscale`.

Keyword arguments also control the
:class:`~matplotlib.lines.Line2D` properties:
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
properties:

%(Line2D)s

Notes
-----
This function supports all the keyword arguments of
:func:`~matplotlib.pyplot.plot` and
:meth:`matplotlib.axes.Axes.set_yscale`.
"""

if not self._hold:
self.cla()
d = {'basey': kwargs.pop('basey', 10),
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.