NREL / reV

Renewable Energy Potential (reV) Model
https://nrel.github.io/reV/
BSD 3-Clause "New" or "Revised" License
107 stars 24 forks source link

Doc updates #421

Closed ppinchuk closed 1 year ago

ppinchuk commented 1 year ago

Some minor documentation additions (in particular to the excl_dict doc)

codecov-commenter commented 1 year ago

Codecov Report

Patch coverage has no change and project coverage change: +0.04% :tada:

Comparison is base (497bb7d) 86.87% compared to head (acd6c09) 86.91%. Report is 5 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #421 +/- ## ========================================== + Coverage 86.87% 86.91% +0.04% ========================================== Files 122 122 Lines 16810 16823 +13 ========================================== + Hits 14603 14622 +19 + Misses 2207 2201 -6 ``` | [Flag](https://app.codecov.io/gh/NREL/reV/pull/421/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/NREL/reV/pull/421/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL) | `86.91% <ø> (+0.04%)` | :arrow_up: | 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=NREL#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files Changed](https://app.codecov.io/gh/NREL/reV/pull/421?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL) | Coverage Δ | | |---|---|---| | [reV/bespoke/bespoke.py](https://app.codecov.io/gh/NREL/reV/pull/421?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL#diff-cmVWL2Jlc3Bva2UvYmVzcG9rZS5weQ==) | `92.02% <ø> (ø)` | | | [reV/generation/generation.py](https://app.codecov.io/gh/NREL/reV/pull/421?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL#diff-cmVWL2dlbmVyYXRpb24vZ2VuZXJhdGlvbi5weQ==) | `87.55% <ø> (+0.05%)` | :arrow_up: | | [reV/supply\_curve/exclusions.py](https://app.codecov.io/gh/NREL/reV/pull/421?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL#diff-cmVWL3N1cHBseV9jdXJ2ZS9leGNsdXNpb25zLnB5) | `83.66% <ø> (ø)` | | | [reV/supply\_curve/sc\_aggregation.py](https://app.codecov.io/gh/NREL/reV/pull/421?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL#diff-cmVWL3N1cHBseV9jdXJ2ZS9zY19hZ2dyZWdhdGlvbi5weQ==) | `81.58% <ø> (ø)` | | ... and [12 files with indirect coverage changes](https://app.codecov.io/gh/NREL/reV/pull/421/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL)

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

ppinchuk commented 1 year ago

Awesome comments, thank you!

The linter error should stop showing up on the main branch