FixedScaleOffset doc: change scale parameter type to float#356
Merged
dstansby merged 3 commits intozarr-developers:mainfrom Aug 24, 2024
Merged
FixedScaleOffset doc: change scale parameter type to float#356dstansby merged 3 commits intozarr-developers:mainfrom
dstansby merged 3 commits intozarr-developers:mainfrom
Conversation
Member
|
Thanks John! 🙏 This makes sense to me. Should we add an example in the docstring and maybe a test filter here? |
dstansby
approved these changes
Aug 24, 2024
Contributor
dstansby
left a comment
There was a problem hiding this comment.
Since this is an improvement I think worth getting it in, even without an example.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #356 +/- ##
=======================================
Coverage 99.91% 99.91%
=======================================
Files 59 59
Lines 2334 2334
=======================================
Hits 2332 2332
Misses 2 2
|
Member
|
Adding a test to this file would be good though. As currently this is untested behavior |
7 tasks
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
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.
This PR is a small change to the documentation of the FixedScaleOffset:
changing the type of the scale parameter from
inttofloat.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_factorandadd_offsetattributes of NetCDF.(emphasis mine)
TODO:
tox -e py310passes locallytox -e docspasses locally