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.

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

519 review abiotic simple and hydrology docstrings to match updated documentation #521

Conversation

vgro
Copy link
Collaborator

@vgro vgro commented Jul 16, 2024

This PR updates the docstrings for the abiotic_simple and hydrology models. Nothing major, only a few bits that were outdated or inconsistent.

Also, I (was trying to) get rid of the variables that are initialized but not needed in the hydrology model. This led to an old problem of random model order on Windows which caused some tests to fail. The change needs to be postponed until the variables system is up and running, see #522

Fixes #519

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works
  • Relevant documentation reviewed and updated

@codecov-commenter
Copy link

codecov-commenter commented Jul 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.93%. Comparing base (bfe28c2) to head (3c49c6c).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #521      +/-   ##
===========================================
- Coverage    94.93%   94.93%   -0.01%     
===========================================
  Files           73       73              
  Lines         4050     4048       -2     
===========================================
- Hits          3845     3843       -2     
  Misses         205      205              

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

Copy link
Collaborator

@jacobcook1995 jacobcook1995 left a comment

Choose a reason for hiding this comment

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

LGTM, apart from the breaking tests.

"cell_id": self.grid.cell_id,
},
)
)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm guessing that it's this change that's causing the tests to break on windows?

@vgro vgro merged commit fb2fea3 into develop Jul 16, 2024
12 checks passed
@vgro vgro deleted the 519-review-abiotic-simple-and-hydrology-docstrings-to-match-updated-documentation branch July 16, 2024 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

review abiotic simple and hydrology docstrings to match updated documentation
3 participants