-
Notifications
You must be signed in to change notification settings - Fork 5
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.
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
Add get_shape_area() and plot_shape() methods to DefaultForcing #464
Add get_shape_area() and plot_shape() methods to DefaultForcing #464
Conversation
needs testing
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #464 +/- ##
==========================================
+ Coverage 78.83% 79.29% +0.45%
==========================================
Files 28 28
Lines 1810 1850 +40
Branches 218 155 -63
==========================================
+ Hits 1427 1467 +40
Misses 325 325
Partials 58 58
|
and fixed a minor thing in get_shape_area()
tested and works, but check fails, I could use some tips on the checks that are being run and the best practices we adhere to in coding style |
Thanks for picking this up! There are instructions in the CONTRIBUTING.md document. I think the instructions are missing that To run the pre-commit hook manually (on all files, not associated with a commit), you can do The codecov check is failing because you've added code that is not tested. If you would add tests for the two functions this should be fixed. For the shape area you can easily check if the output is numerically correct. Testing the plotting code is more difficult, maybe we only check if it ran without errors. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These suggestions should fix most issues.
Co-authored-by: Bart Schilperoort <[email protected]>
Co-authored-by: Bart Schilperoort <[email protected]>
Co-authored-by: Bart Schilperoort <[email protected]>
I've fixed the linting/formatting issues and added tests for the new methods. Everything's good now ✔️ |
first commit added get_shape_area (needs testing)