Skip to content

numpydoc set_size_inches docstring #15044

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

Jump to bottom
Merged
merged 1 commit into from
Aug 13, 2019
Merged

numpydoc set_size_inches docstring #15044

merged 1 commit into from
Aug 13, 2019

Conversation

dstansby
Copy link
Member

n.b. I have no idea what the description for the forward argument really means, so if anyone has a better suggestion than what is present please let me know!

anntzer
anntzer reviewed Aug 12, 2019
View reviewed changes
@tacaswell
Copy link
Member

If forward is False then the figure and the GUI window can get out of sync which means you will either see just part of the figure or the figure won't take up the whole GUI. We need this knob so that when we re-size the Figure from the GUI we don't get our selves into an infinite loop!

tacaswell
tacaswell reviewed Aug 12, 2019
View reviewed changes
@tacaswell tacaswell added this to the v3.2.0 milestone Aug 12, 2019
tacaswell
tacaswell reviewed Aug 12, 2019
View reviewed changes
lib/matplotlib/figure.py
w : tuple of floats or float
Width and height in inches (if height not specified as a separate
argument) or width.
h : float
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
h : float
h : float, optional

Specifying the default here does not make lots of sense due to the weird interaction with w.

tacaswell
tacaswell reviewed Aug 12, 2019
View reviewed changes
tacaswell
tacaswell approved these changes Aug 12, 2019
View reviewed changes
Copy link
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

Modulo my two extra line comments.

It makes the docs better which is the merge criteria on docs ;)

timhoffm
timhoffm reviewed Aug 12, 2019
View reviewed changes
@timhoffm
Copy link
Member

timhoffm commented Aug 13, 2019 •
edited
Loading

flake8:

./lib/matplotlib/figure.py:895:80: E501 line too long (80 > 79 characters)

Edit: maybe we should install https://github.com/OrkoHunter/pep8speaks

@tacaswell tacaswell merged commit 67c7dca into matplotlib:master Aug 13, 2019
@dstansby dstansby deleted the set_size-npydc branch September 5, 2019 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anntzer anntzer anntzer left review comments

@tacaswell tacaswell tacaswell approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.
4 participants
@dstansby @tacaswell @timhoffm @anntzer