If this pull request has any implications for data or metadata processing or addresses an issue labeled sci review, please include an overview of the methods used (e.g., briefly explain how the data gets processed).
See #267 for rationale.
Include sufficient detail for reviewers or users that are not expert developers to evaluate the validity of the approach.
Please attach or link to example input and output data if applicable.
It may also be appropriate to include a description of any functional or unit tests in this section depending on their content.
Any pull request with a methods section requires scientific review in addition to code review.
Types of changes
What types of changes does your code introduce?
Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Functional tests
List out the functional tests you've completed to verify your changes work locally.
Checklist
Put an x in the boxes that apply.
[ ] Lint and unit tests pass locally with my changes
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation (if appropriate)
[ ] Any dependent changes have been merged and published in downstream modules
Screenshots
Please attach any screenshots that illustrate these changes.
Issue Number
Include an issue number if applicable.
Purpose/Implementation Notes
Describe the big picture of your changes.
Methods
If this pull request has any implications for data or metadata processing or addresses an issue labeled
sci review
, please include an overview of the methods used (e.g., briefly explain how the data gets processed). See #267 for rationale. Include sufficient detail for reviewers or users that are not expert developers to evaluate the validity of the approach. Please attach or link to example input and output data if applicable. It may also be appropriate to include a description of any functional or unit tests in this section depending on their content. Any pull request with a methods section requires scientific review in addition to code review.Types of changes
What types of changes does your code introduce?
Functional tests
List out the functional tests you've completed to verify your changes work locally.
Checklist
Put an
x
in the boxes that apply.Screenshots
Please attach any screenshots that illustrate these changes.