OpenFreeEnergy / openfe

The Open Free Energy toolkit
https://docs.openfree.energy
MIT License
124 stars 15 forks source link

Update CLI help docs #797

Closed IAlibay closed 3 months ago

IAlibay commented 3 months ago

Related to #796

This PR only updates the help docs to reflect the current status of the CLI.

Checklist

Developers certificate of origin

codecov[bot] commented 3 months ago

Codecov Report

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

Project coverage is 91.40%. Comparing base (223e49a) to head (e284dd4).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #797 +/- ## ========================================== - Coverage 94.12% 91.40% -2.72% ========================================== Files 133 133 Lines 9767 9767 ========================================== - Hits 9193 8928 -265 - Misses 574 839 +265 ``` | [Flag](https://app.codecov.io/gh/OpenFreeEnergy/openfe/pull/797/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenFreeEnergy) | Coverage Δ | | |---|---|---| | [fast-tests](https://app.codecov.io/gh/OpenFreeEnergy/openfe/pull/797/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenFreeEnergy) | `91.40% <ø> (?)` | | | [slow-tests](https://app.codecov.io/gh/OpenFreeEnergy/openfe/pull/797/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenFreeEnergy) | `?` | | 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=OpenFreeEnergy#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.