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

Add user docs demonstrating demography traits and crown properties #313

Conversation

davidorme
Copy link
Collaborator

@davidorme davidorme commented Sep 30, 2024

Description

This PR is mostly about creating some draft intro docs for users for the demography classes and methods. I have also added some __repr__ methods to classes and a few information attributes to classes.

Since this is a doc heavy PR, I've set the branch to build on RTD. The new docs are the ones under this TOC heading.

https://pyrealm.readthedocs.io/en/312-add-user-docs-demonstrating-demography-traits-and-crown-properties/users/demography/module_overview.html

Fixes #312 (issue)

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

@codecov-commenter
Copy link

codecov-commenter commented Sep 30, 2024

Codecov Report

Attention: Patch coverage is 87.50000% with 6 lines in your changes missing coverage. Please review.

Project coverage is 95.70%. Comparing base (1f315ba) to head (7c47deb).
Report is 183 commits behind head on develop.

Files with missing lines Patch % Lines
pyrealm/demography/t_model_functions.py 85.00% 3 Missing ⚠️
pyrealm/demography/crown.py 80.00% 2 Missing ⚠️
pyrealm/demography/flora.py 94.44% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #313      +/-   ##
===========================================
+ Coverage    95.29%   95.70%   +0.41%     
===========================================
  Files           28       34       +6     
  Lines         1720     2469     +749     
===========================================
+ Hits          1639     2363     +724     
- Misses          81      106      +25     

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

@davidorme davidorme merged commit 294c0d6 into develop Oct 3, 2024
12 checks passed
@davidorme davidorme deleted the 312-add-user-docs-demonstrating-demography-traits-and-crown-properties branch October 3, 2024 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add user docs demonstrating demography traits and crown properties.
3 participants