assume-framework / assume

ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution
https://assume.readthedocs.io
22 stars 5 forks source link

Adjust docstrings #281

Closed adamsjohanna closed 7 months ago

adamsjohanna commented 7 months ago

Adjust and add docstrings for all modules used in the advanced orders tutorial (in process).

codecov[bot] commented 7 months ago

Codecov Report

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

Comparison is base (564bc4d) 0.00% compared to head (974afea) 83.03%.

:exclamation: Current head 974afea differs from pull request most recent head 34e9f54. Consider uploading reports for the commit 34e9f54 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #281 +/- ## ========================================= + Coverage 0 83.03% +83.03% ========================================= Files 0 40 +40 Lines 0 4538 +4538 ========================================= + Hits 0 3768 +3768 - Misses 0 770 +770 ``` | [Flag](https://app.codecov.io/gh/assume-framework/assume/pull/281/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework) | Coverage Δ | | |---|---|---| | [pytest](https://app.codecov.io/gh/assume-framework/assume/pull/281/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework) | `83.03% <ø> (?)` | | 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=assume-framework#carryforward-flags-in-the-pull-request-comment) to find out more.

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