Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Review of spatial averaging and general dataset utilities #644

Merged
merged 7 commits into from
Apr 18, 2024
Merged

Review of spatial averaging and general dataset utilities #644

merged 7 commits into from
Apr 18, 2024

Conversation

pochedls
Copy link
Collaborator

Description

Routine review of gallery examples to make sure API is correct, to add any new functionality, and to try to make examples clearer.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

If applicable:

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass with my changes (locally and CI/CD build)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have noted that this is a breaking change for a major release (fix or feature that would cause existing functionality to not work as expected)

tomvothecoder
tomvothecoder approved these changes Apr 17, 2024
View reviewed changes
Copy link
Collaborator

@tomvothecoder tomvothecoder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Steve, I made some minor updates to your notebooks directly because I wasn't able to suggest the changes.

  1. Update conda env command used between notebooks for consistency. That way the user can use the same xcdat_notebook environment for all of the notebooks.
  2. The black code formatter made some automatic formatting changes

Everything else looks good. I also liked how you added the HTML for the warning block. I wasn't able to generate a similar block using markdown, so this will be handy to know.

@codecov Codecov
Copy link

codecov bot commented Apr 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (145a03e) to head (aa00419).

Additional details and impacted files 
@@            Coverage Diff            @@
##              main      #644   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           15        15           
  Lines         1543      1543           
=========================================
  Hits          1543      1543

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tomvothecoder tomvothecoder merged commit 06eb559 into xCDAT:main Apr 18, 2024
9 checks passed
@tomvothecoder tomvothecoder mentioned this pull request Apr 30, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tomvothecoder tomvothecoder tomvothecoder approved these changes

Assignees
No one assigned
Labels
None yet
Projects
xCDAT FY24 Development
Status: Done
Milestone
FY24Q3 (4/01/24 - 06/30/24)
Development

Successfully merging this pull request may close these issues.

[Doc]: Routine review of documentation for accuracy and relevancy
2 participants
@pochedls @tomvothecoder