Skip to content
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

PEP8ify some variable names. #15204

Merged
merged 1 commit into from Sep 7, 2019
Merged

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 6, 2019

nrows/ncols is already used as parameter names in subplots() so
standardizing on them seems good enough.

Note that the docstring of SubplotBase was previously incorrect:
one didn't need numRows <= numCols <= plotNum < 10, just that all
three be single-digit.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 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

@tacaswell tacaswell added this to the v3.3.0 milestone Sep 6, 2019
----------
fig : `matplotlib.figure.Figure`

*args : tuple (*nrows*, *ncols*, *index*)
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
*args : tuple (*nrows*, *ncols*, *index*)
*args : tuple (*nrows*, *ncols*, *index*) or int

I think that should be mentioned, even though the int has very special semantics.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

decimal integer *numRows* * 100 + *numCols* * 10 + *plotNum*.
fig : `matplotlib.figure.Figure`

*args : tuple (*nrows*, *ncols*, *index*)
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
*args : tuple (*nrows*, *ncols*, *index*)
*args : tuple (*nrows*, *ncols*, *index*) or int

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

nrows/ncols is already used as parameter names in subplots() so
standardizing on them seems good enough.

Note that the docstring of SubplotBase was previously incorrect:
one didn't need `numRows <= numCols <= plotNum < 10`, just that all
three be single-digit.
@timhoffm timhoffm merged commit 82eca12 into matplotlib:master Sep 7, 2019
@anntzer anntzer deleted the nrowsncols branch September 7, 2019 12:39
@tacaswell tacaswell modified the milestones: v3.3.0, v3.2.0 Sep 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants