-
Notifications
You must be signed in to change notification settings - Fork 9
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
Merged
davidorme
merged 22 commits into
develop
from
312-add-user-docs-demonstrating-demography-traits-and-crown-properties
Oct 3, 2024
Merged
Add user docs demonstrating demography traits and crown properties #313
davidorme
merged 22 commits into
develop
from
312-add-user-docs-demonstrating-demography-traits-and-crown-properties
Oct 3, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…y-traits-and-crown-properties
Codecov ReportAttention: Patch coverage is
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. |
Co-authored-by: Marion <[email protected]>
…y-traits-and-crown-properties
MarionBWeinzierl
approved these changes
Oct 3, 2024
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Key checklist
pre-commit
checks:$ pre-commit run -a
$ poetry run pytest
Further checks