Sanitize input for plotItem.showGrid (was documentation fix for plotItem.showGrid alpha setting) #1809
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.
Looking through some issues, I came across #1484:
setting
plotItem.showGrid(True, True, alpha=0.5)
raisesTypeError: setValue(self, int): argument 1 has unexpected type 'numpy.float64'
This is a documentation error:
The expected alpha value does not range from 0.0 to 1.0 (as in the current docstring), but instead ranges from 0-255.
This PR updates the docstring to show that and adds a cast to int to avoid raising an error.
The
alpha=0.5
value in the original report will no longer result in an error and draw an invisible, fully transparent grid.Setting
alpha=127
creates the desired half-transparent grid.So this should close #1484.