PSLmodels / Tax-Calculator

USA Federal Individual Income and Payroll Tax Microsimulation Model
https://taxcalc.pslmodels.org
Other
255 stars 154 forks source link

Move license file #2706

Closed jdebacker closed 7 months ago

jdebacker commented 10 months ago

This PR moves the license file out of the Jupyter Book documentation files to the root directory of the repo. Resolves Issue #2639.

codecov[bot] commented 10 months ago

Codecov Report

Merging #2706 (97664bc) into master (6798fba) will not change coverage. Report is 1 commits behind head on master. The diff coverage is n/a.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/PSLmodels/Tax-Calculator/pull/2706/graphs/tree.svg?width=650&height=150&src=pr&token=KqtTvRSNjQ&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels)](https://app.codecov.io/gh/PSLmodels/Tax-Calculator/pull/2706?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) ```diff @@ Coverage Diff @@ ## master #2706 +/- ## ======================================= Coverage 98.54% 98.54% ======================================= Files 14 14 Lines 2609 2609 ======================================= Hits 2571 2571 Misses 38 38 ``` | [Flag](https://app.codecov.io/gh/PSLmodels/Tax-Calculator/pull/2706/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/Tax-Calculator/pull/2706/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) | `98.54% <ø> (ø)` | | 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/Tax-Calculator/pull/2706?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) | Coverage Δ | | |---|---|---| | [taxcalc/utils.py](https://app.codecov.io/gh/PSLmodels/Tax-Calculator/pull/2706?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels#diff-dGF4Y2FsYy91dGlscy5weQ==) | `97.79% <ø> (ø)` | |
jdebacker commented 9 months ago

@MattHJensen This PR is ready for your review.

The change is to move license.md out of the Jupyter Book documentation and to the root directory so that it shows up on the main page of the GH repo.

If we still feel like it should be in those docs (e.g., at https://taxcalc.pslmodels.org) then I am happy to duplicate the file and have it in both places. But Jupyter Book can't handle compiling with files above the root directory for the book.

MattHJensen commented 9 months ago

@jdebacker, I think duplicate the license and then good to merge. Nice to have both places. License doesn't change, so duplication isn't a maintenance issue.

jdebacker commented 9 months ago

Per @MattHJensen's suggestion, the license file has been duplicated so it ships with the documentation as well.

jdebacker commented 8 months ago

@MattHJensen Do this PR look good now?