search

PSLmodels / OG-Core

An overlapping generations model framework for evaluating fiscal policies.
https://pslmodels.github.io/OG-Core/
Creative Commons Zero v1.0 Universal
65 stars 111 forks source link

Add HSV functions to valid `tax_func_type` #941

Closed jdebacker closed 2 months ago

jdebacker commented 2 months ago

This PR updates the default_parameters.json file to add the HSV tax function type (HSV) to the list of valid entries for the tax_func_type parameter. This should have been added in PR #932, but was left out.

In addition, this PR updates the documentation files and some docstrings to reduce the number of warnings Jupyter-Book issues (partially addressing Issue #747).

codecov-commenter commented 2 months ago

Codecov Report

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

Project coverage is 71.92%. Comparing base (c16cf28) to head (f940b5a). Report is 2 commits behind head on master.

:exclamation: Current head f940b5a differs from pull request most recent head 2e2a85f

Please upload reports for the commit 2e2a85f to get more accurate results.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/941/graphs/tree.svg?width=650&height=150&src=pr&token=98mQCVhspd&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels)](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/941?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) ```diff @@ Coverage Diff @@ ## master #941 +/- ## ========================================== - Coverage 71.93% 71.92% -0.02% ========================================== Files 19 19 Lines 4725 4723 -2 ========================================== - Hits 3399 3397 -2 Misses 1326 1326 ``` | [Flag](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/941/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/941/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) | `71.92% <100.00%> (-0.02%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/941?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) | Coverage Δ | | |---|---|---| | [ogcore/\_\_init\_\_.py](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/941?src=pr&el=tree&filepath=ogcore%2F__init__.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels#diff-b2djb3JlL19faW5pdF9fLnB5) | `100.00% <100.00%> (ø)` | | | [ogcore/elliptical\_u\_est.py](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/941?src=pr&el=tree&filepath=ogcore%2Felliptical_u_est.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels#diff-b2djb3JlL2VsbGlwdGljYWxfdV9lc3QucHk=) | `100.00% <ø> (ø)` | | | [ogcore/utils.py](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/941?src=pr&el=tree&filepath=ogcore%2Futils.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels#diff-b2djb3JlL3V0aWxzLnB5) | `86.49% <ø> (ø)` | |
rickecon commented 2 months ago

@jdebacker. This is great. Thanks for fixing all those errors in the documentation. And the HSV addition in the documentation and in the default_parameters.json is nice. Merging.