Clean up BoundaryNorm docstring #8007
Conversation
lib/matplotlib/colors.py
Outdated
| then v is mapped to color j; | ||
| Notes | ||
| ----- | ||
| If :code:`b[i] <= v < b[i+1]` then v is mapped to color j; |
There was a problem hiding this comment.
What happens if the two lengths don't match?
There was a problem hiding this comment.
I have no idea, will try and work out and update this later today.
lib/matplotlib/colors.py
Outdated
| ncolors : int | ||
| Number of colors in the colormap to be used | ||
| clip : bool, optional | ||
| If clip is *True*, out of range values are mapped to *0* if they |
There was a problem hiding this comment.
Use double backquotes here and below.
There was a problem hiding this comment.
For clip or for True and 0?
There was a problem hiding this comment.
I would say for all (they're all "code").
There was a problem hiding this comment.
But http://matplotlib.org/devdocs/devel/documenting_mpl.html#formatting says to explicitly not do that! (at least for arguments to functions)
There was a problem hiding this comment.
Indeed, that simply means I've been doing things wrong :-)
https://docs.python.org/devguide/documenting.html#id3 (the mpl docs refer to consistency with python itself) says to use emphasis specifically for local variables (i.e. arguments) only.
lib/matplotlib/colors.py
Outdated
| Notes | ||
| ----- | ||
| If :code:`b[i] <= v < b[i+1]` then v is mapped to | ||
| floor( :math:`\frac{n_{colors}- 1}{n_{bins} - 1} * i`), where nbins is |
There was a problem hiding this comment.
should the floor function be in the math directive?
There was a problem hiding this comment.
I thought it looked better visually outside, but I can put it inside.
There was a problem hiding this comment.
Actually this is about to go in my next revision anyway
lib/matplotlib/colors.py
Outdated
| above *boundaries[-1]*. | ||
| If *clip* is ``True``, out of range values are mapped to 0 if they | ||
| are below ``boundaries[0]`` or mapped to *ncolors* - 1 if they are | ||
| above ``boundaries[-1]``. | ||
|
|
||
| If clip is *False*, out of range values are mapped to *-1* if they |
There was a problem hiding this comment.
False and boundaries[0] to be consistent with the previous paragrpha
lib/matplotlib/colors.py
Outdated
| b[i] <= v < b[i+1] | ||
| Parameters | ||
| ---------- | ||
| boundaries : sequence |
lib/matplotlib/colors.py
Outdated
| ncolors : int | ||
| Number of colors in the colormap to be used | ||
| clip : bool, optional | ||
| If *clip* is ``True``, out of range values are mapped to 0 if they |
There was a problem hiding this comment.
Can you please remove the *? They make docstrings hard to read in the terminal
| Raises | ||
| ------ | ||
| ValueError | ||
| BoundaryNorm is not invertible, so calling this method will always |
|
Those should be fixed now |
lib/matplotlib/colors.py
Outdated
| If clip == True, out-of-range values | ||
| are mapped to 0 if low and ncolors-1 if high. | ||
| If the number of bins doesn't equal *ncolors*, the color is chosen | ||
| by linear inpolation of the bin number onto color numbers. |
|
Thanks! |
invertwill always raise aValueError