sdfordham / pysyncon

A python module for the synthetic control method
MIT License
45 stars 12 forks source link

Add some docstrings #11

Closed sdfordham closed 1 year ago

codecov-commenter commented 1 year ago

Codecov Report

Base: 95.20% // Head: 96.29% // Increases project coverage by +1.08% :tada:

Coverage data is based on head (a307bb8) compared to base (269aa07). Patch coverage: 96.00% of modified lines in pull request are covered.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #11 +/- ## ========================================== + Coverage 95.20% 96.29% +1.08% ========================================== Files 13 13 Lines 626 648 +22 ========================================== + Hits 596 624 +28 + Misses 30 24 -6 ``` | [Impacted Files](https://codecov.io/gh/sdfordham/pysyncon/pull/11?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Stiof%C3%A1in+Fordham) | Coverage Δ | | |---|---|---| | [pysyncon/augsynth.py](https://codecov.io/gh/sdfordham/pysyncon/pull/11?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Stiof%C3%A1in+Fordham#diff-cHlzeW5jb24vYXVnc3ludGgucHk=) | `98.41% <ø> (ø)` | | | [pysyncon/dataprep.py](https://codecov.io/gh/sdfordham/pysyncon/pull/11?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Stiof%C3%A1in+Fordham#diff-cHlzeW5jb24vZGF0YXByZXAucHk=) | `95.74% <ø> (ø)` | | | [pysyncon/synth.py](https://codecov.io/gh/sdfordham/pysyncon/pull/11?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Stiof%C3%A1in+Fordham#diff-cHlzeW5jb24vc3ludGgucHk=) | `93.22% <ø> (+1.69%)` | :arrow_up: | | [pysyncon/utils.py](https://codecov.io/gh/sdfordham/pysyncon/pull/11?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Stiof%C3%A1in+Fordham#diff-cHlzeW5jb24vdXRpbHMucHk=) | `100.00% <ø> (ø)` | | | [pysyncon/base.py](https://codecov.io/gh/sdfordham/pysyncon/pull/11?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Stiof%C3%A1in+Fordham#diff-cHlzeW5jb24vYmFzZS5weQ==) | `81.92% <66.66%> (+6.02%)` | :arrow_up: | | [tests/test\_synth.py](https://codecov.io/gh/sdfordham/pysyncon/pull/11?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Stiof%C3%A1in+Fordham#diff-dGVzdHMvdGVzdF9zeW50aC5weQ==) | `100.00% <100.00%> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Stiof%C3%A1in+Fordham). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Stiof%C3%A1in+Fordham)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.