Reword BoundaryNorm docs. #20898
Merged
Reword BoundaryNorm docs. #20898
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
story645
reviewed
Aug 25, 2021
lib/matplotlib/colors.py
Outdated
| instead of to the interval 0-1. (Mapping to the 0-1 interval could have | ||
| been done via piece-wise linear interpolation, but using integers seems | ||
| simpler, and reduces the number of conversions back and forth between int | ||
| and float.) |
There was a problem hiding this comment.
Is out of scope of the PR, I know, but does the parenthetical part need to be rendered in the docs? This seems like an implementation detail?
There was a problem hiding this comment.
sure, moved it to a comment.
lib/matplotlib/colors.py
Outdated
| This method behaves similarly to `.Normalize.__call__`, but returns | ||
| integers or arrays of int16, instead of floats in the ``[0, 1]`` |
There was a problem hiding this comment.
I don't think it needs the "instead of floats" parts. Folks can look up the other normalize methods if they need to know the difference, and that there is a difference has already been noted via the 'but'
In particular, move the `Returns` block from `__init__` to `__call__`, where it actually belongs. I believe that Norms are low-level enough constructs that it is sufficient to just refer to the base class docstring, without going through fancy docstring interpolation.
story645
approved these changes
Aug 25, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
In particular, move the
Returnsblock from__init__to__call__,where it actually belongs. I believe that Norms are low-level enough
constructs that it is sufficient to just refer to the base class
docstring, without going through fancy docstring interpolation.
PR Summary
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).