DOC: hexbin 'extent' must be 4-tuple of float, not float #20485
Conversation
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
lib/matplotlib/axes/_axes.py
Outdated
| The limits of the bins. The default assigns the limits | ||
| based on *gridsize*, *x*, *y*, *xscale* and *yscale*. |
There was a problem hiding this comment.
if you are fixing, this maybe be explicit since we have at least 4 different ways to assign extents in the library:
| The limits of the bins. The default assigns the limits | |
| based on *gridsize*, *x*, *y*, *xscale* and *yscale*. | |
| The limits of the bins (xmin, xmax, ymin, ymax) . The default assigns the limits | |
| based on *gridsize*, *x*, *y*, *xscale* and *yscale*. |
There was a problem hiding this comment.
thanks, that makes sense. I probably violated some 79 char line width rule now by committing, right?
There was a problem hiding this comment.
That's actually already there in the third paragraph. If we move it here, then that line can be deleted.
There was a problem hiding this comment.
thanks, removed in 569336b
Co-authored-by: Jody Klymak <jklymak@gmail.com>
|
... sorry I should have been more careful in the diff - you need to make sure each line is not more than 79 characters. |
|
Thanks @sappelhoff! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again. |
|
Thank you :-) I also hope to be of more help in the future! |
PR Summary
In this PR I want to fix the docstring for the hexbin parameter
extent:matplotlib/lib/matplotlib/axes/_axes.py
Line 4650 in 2a3037f
It previously said "float", but it actually wants a 4-tuple of floats, as evident from the code:
matplotlib/lib/matplotlib/axes/_axes.py
Lines 4755 to 4756 in 2a3037f
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).