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

Docstring fix. #9569

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 25, 2017
Merged

Docstring fix. #9569

merged 1 commit into from
Oct 25, 2017

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Oct 25, 2017

just moving a comment into a docstring.

PR Summary

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

@dstansby dstansby self-assigned this Oct 25, 2017
@@ -2644,23 +2644,19 @@ class FigureManagerBase(object):
num : int or str
The figure number

key_press_handler_id : int
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this whole bit of docstring be under __init__ below? I don't think either place is right for key_press_handler_id anyway, since neither method takes that as a parameter.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's documented as a class attribute, not as a constructor parameter.

@dstansby dstansby removed their assignment Oct 25, 2017
@dstansby dstansby added this to the v2.1.1 milestone Oct 25, 2017
@dstansby dstansby merged commit c639af4 into matplotlib:master Oct 25, 2017
lumberbot-app bot pushed a commit that referenced this pull request Oct 25, 2017
@anntzer anntzer deleted the docstring-fix branch October 25, 2017 15:54
dopplershift added a commit that referenced this pull request Oct 25, 2017
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.

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