Check parameters of ColorbarBase #14519
Merged
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
anntzer
reviewed
Jun 18, 2019
a0a108a to
8785e88
Compare
anntzer
reviewed
Jul 22, 2019
anntzer
reviewed
Jul 22, 2019
|
|
||
| Parameters | ||
| ---------- | ||
| ax : `~matplotlib.axes.Axes` |
There was a problem hiding this comment.
blank lines are not consistent.
There was a problem hiding this comment.
Usually, I would not add blank lines here, because the descriptions are short.
Only where no description is present at all, I've added a blank line (or rather an indented empty description 😉). I think that's a fair compromise. Otherwise the parameters would be visually merged to one block.
And you were right anyway, there was no blank line between norm and alpha. Fixed that.
Ideally, one would write descriptions for all, but that's not the focus of this PR.
8785e88 to
7e33b81
Compare
7e33b81 to
936905e
Compare
tacaswell
approved these changes
Aug 8, 2019
dopplershift
approved these changes
Aug 8, 2019
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.
PR Summary
Add some type and value checks to the parameters of
ColorbarBase.__init__. Also start a bit of documentation. Documentation is still incomplete. There are a number of parameters I don't fully understand myself, and figuring everything out was too much for the moment. Further improvements on the documentation are welcome 😄.This PR would have prevented #14517.