In colorbar docs, add ref from 'boundaries' doc to 'spacing' doc. #28942
Conversation
This file contains hidden or 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
The `spacing` kwarg only makes sense in relation to `boundaries`, so put the docs for them next to one another and add an explicit reference from `boundaries` to `spacing`. (The order of the kwargs in the signature did not change, because it already doesn't match the docs anyways; reordering them could be done separately.)
timhoffm
approved these changes
Oct 7, 2024
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.
Suggestion cannot be applied right now. Please check back later.
The
spacingkwarg only makes sense in relation toboundaries, so put the docs for them next to one another and add an explicit reference fromboundariestospacing. (The order of the kwargs in the signature did not change, because it already doesn't match the docs anyways; reordering them could be done separately.)Closes #12312 (by documenting the behavior rather than trying to change anything).
PR summary
PR checklist