ImperialCollegeLondon / pyrealm

Development of the pyrealm package, providing an integrated toolbox for modelling plant productivity, growth and demography using Python.

https://pyrealm.readthedocs.io/

MIT License

19 stars 8 forks source link

Fixing missing attribute docstrings in `core.calendar` #182

Closed davidorme closed 6 months ago

davidorme commented 6 months ago

Description

This PR:

Adds attribute docstrings to Calendar and CalendarDay
Updates the docstrings throughout the module.
Adds a custom and more compact __repr__ for both dataclasses. Fixes #164

Type of change

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

Key checklist

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

Further checks

[x] Code is commented, particularly in hard-to-understand areas
[x] Tests added that prove fix is effective or that feature works

codecov-commenter commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (caab98b) 93.57% compared to head (73dea49) 93.80%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #182 +/- ## =========================================== + Coverage 93.57% 93.80% +0.22% =========================================== Files 28 28 Lines 1464 1468 +4 =========================================== + Hits 1370 1377 +7 + Misses 94 91 -3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

davidorme commented 6 months ago

Hi @surbhigoel77 - can you re-review and approve? You've added a "comment review" but I need an "approving review" to merge it 😄

surbhigoel77 commented 6 months ago

Hi @surbhigoel77 - can you re-review and approve? You've added a "comment review" but I need an "approving review" to merge it 😄

Corrected. :)