FixedScaleOffset doc: change scale parameter type to float #356
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.
This PR is a small change to the documentation of the FixedScaleOffset:
changing the type of the scale parameter from
int
tofloat
.The filter currently behaves reasonably and as I would expect if a passing a float to the scale parameter:
and is a potentially useful application of this filter.
As well, this documentation change makes this filter's description consistent with the
scale_factor
andadd_offset
attributes of NetCDF.(emphasis mine)
TODO:
tox -e py310
passes locallytox -e docs
passes locally