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.

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

Conversation

kianasun
Copy link
Contributor

@kianasun kianasun commented Oct 2, 2017

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

**kwargs :
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
properties:
**kwargs : Keyword arguments control the :class:`~matplotlib.lines.Line2D` properties:
Copy link
Contributor

Choose a reason for hiding this comment

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

Please keep the description on its own line (only type information should really be on the same line).

@@ -1631,7 +1629,8 @@ 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.

@tacaswell tacaswell added this to the 2.1.1 (next bug fix release) milestone Oct 3, 2017
@kianasun kianasun force-pushed the semilog-doc branch 3 times, most recently from 9de5a19 to 8a8ceaf Compare October 4, 2017 06:58
@anntzer
Copy link
Contributor

anntzer commented Oct 4, 2017

... did you undo most of your work?

@kianasun
Copy link
Contributor Author

kianasun commented Oct 4, 2017

No, I didn't undo most of my work, I just updated semilogy to make it match semilogx.

@kianasun
Copy link
Contributor Author

kianasun commented Oct 5, 2017

Sorry, I misunderstood you. I also changed the Parameter part of semilogy this time to exactly match semilogx.

Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

👍 thanks for the fix!

@dstansby dstansby merged commit 790c843 into matplotlib:master Oct 6, 2017
QuLogic added a commit that referenced this pull request Oct 6, 2017
@tacaswell
Copy link
Member

@skx19952 I think this was your first MPL PR? Congratulations 🎉 Hopefully we will hear from you again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.