DOC better docstring for hist2d #8429
Conversation
| @@ -6457,7 +6457,21 @@ def hist2d(self, x, y, bins=10, range=None, normed=False, weights=None, | |||
|
|
|||
| Other parameters | |||
| ---------------- | |||
| kwargs : :meth:`pcolorfast` properties. | |||
| cmap : [None, Colormap, string], optional | |||
There was a problem hiding this comment.
Would it be okay to get rid of the square brackets? I don't think they're anywhere else (or at least haven't been in recent doc PRs)
There was a problem hiding this comment.
@dstansby see section 4: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
if anything, they should be {}'s
| luminance data to 0,1. If None, defaults to normalize() | ||
|
|
||
| vmin/vmax : [None | scalar] | ||
| vmin and vmax are used in conjunction with norm to normalize |
There was a problem hiding this comment.
vmin and vmax (they're keyword arguments)
| luminance data. | ||
|
|
||
| alpha : ``0 <= scalar <= 1`` or *None* | ||
| the alpha blending value |
|
I assume the closing is accidental? (Feel free to leave a note and reclose if it is not.) |
|
No. I am not spending more time on those documentation pull requests. It takes more time to go through the reviewing process than it is to make the actual pull request. It's a loss of both reviewer's time and contributor's time. I am not spending time on this. |
|
@NelleV If you think that we should have a policy of merging documentation PRs with less strict review, as long as they're an improvement, I think this should be brought up on the usual channels. FWIW I would probably be +0 on such a change, as doc PRs do not introduce backcompatibility issues and their review can indeed drag on forever. |
|
Sure, but I don't have time to deal with this right now. I've got too much on my plate. The only reason I opened this PR is I had to look for this information and it took me 2 minutes and not 10sec like it should have. |
The docstring referenced a function that is hard to access to interactively. Changed the docstring to explicitely describe parameters.