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

Feature/update module overview #224

Merged
merged 7 commits into from
May 25, 2023
Merged

Conversation

vgro
Copy link
Collaborator

@vgro vgro commented May 24, 2023

This PR adds a description of the abiotic_simple_model to the module overview.

I don't remember what we agreed regarding module/ model, I thought is was model but it is a bit mixed in this file. I am happy to make the changes with your ok.

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

@codecov-commenter
Copy link

codecov-commenter commented May 24, 2023

Codecov Report

Merging #224 (ba1dd7c) into develop (531c93d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop     #224   +/-   ##
========================================
  Coverage    95.18%   95.18%           
========================================
  Files           35       35           
  Lines         1494     1494           
========================================
  Hits          1422     1422           
  Misses          72       72           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

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!

Unfortunately, I also can't remember what we agreed on in terms of module vs model when referring to our respective sections of code.

docs/source/virtual_rainforest/module_overview.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@davidorme davidorme left a comment

Choose a reason for hiding this comment

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

LGTM too. I'd go with model, I think. We have a BaseModel and module is widely used in Python to talk about organisational units of code more widely.

@vgro vgro merged commit 5ca2055 into develop May 25, 2023
@vgro vgro deleted the feature/update_module_overview branch May 25, 2023 08:21
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.

4 participants