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

Documentation of model parameters #963

Merged
merged 11 commits into from
Aug 10, 2024
Merged

Conversation

jdebacker
Copy link
Member

This PR adds utilities to generate a chapter of the OG-Core documentation that describes each model parameter using metadata from default_parameters.py. Github Actions are updated to ensure this page is regenerated and compiled with the documentation at each PR.

View of the new chapter:

Screenshot 2024-08-08 at 12 09 37 PM

@jdebacker
Copy link
Member Author

Relates to Issue #954

@jdebacker
Copy link
Member Author

Also addes rst file for pension model API, addressing Issue #953

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 10.52632% with 17 lines in your changes missing coverage. Please review.

Project coverage is 71.07%. Comparing base (e799452) to head (2f66a35).
Report is 2 commits behind head on master.

Files Patch % Lines
ogcore/utils.py 10.52% 17 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #963      +/-   ##
==========================================
- Coverage   71.31%   71.07%   -0.24%     
==========================================
  Files          20       20              
  Lines        4953     4972      +19     
==========================================
+ Hits         3532     3534       +2     
- Misses       1421     1438      +17     
Flag Coverage Δ
unittests 71.07% <10.52%> (-0.24%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
ogcore/utils.py 84.13% <10.52%> (-3.05%) ⬇️

@rickecon
Copy link
Member

@jdebacker. This is such a cool addition to the documentation. Merging.

@rickecon rickecon merged commit 32f2593 into PSLmodels:master Aug 10, 2024
8 checks passed
@rickecon rickecon mentioned this pull request Aug 10, 2024
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.

3 participants