Skip to content

Minor docstring fixes #11626

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
Jul 13, 2018
Merged

Minor docstring fixes #11626

merged 1 commit into from
Jul 13, 2018

Conversation

timhoffm
Copy link
Member

PR Summary

Copy link
Member

@QuLogic QuLogic left a comment

Choose a reason for hiding this comment

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

LGTM, modulo two minor things.

@@ -575,6 +575,7 @@ def gcf():


def fignum_exists(num):
"""Return whether the figure with the given number exists."""
Copy link
Member

Choose a reason for hiding this comment

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

Technically figure numbers don't need to be numbers; I'm not sure how to convey that succinctly in the one line though.

Copy link
Member Author

Choose a reason for hiding this comment

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

We could use id instead of num. Would it be permissible to change the argument name as well? Technically, that would be a breaking change if someone used it as a kwarg. However, thats rather unlikely, as there is no good reason to do it here?

@@ -591,6 +592,11 @@ def get_figlabels():


def get_current_fig_manager():
"""
Return the figure manager of he active figure.
Copy link
Member

Choose a reason for hiding this comment

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

the

@NelleV
Copy link
Member

NelleV commented Jul 13, 2018

Thanks @timhoffm !

@NelleV NelleV merged commit 5669d1c into matplotlib:master Jul 13, 2018
@QuLogic QuLogic added this to the v3.0 milestone Jul 13, 2018
@timhoffm timhoffm deleted the doc-minor-issues branch July 13, 2018 21:10
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.

3 participants