mosdef-hub / mbuild

A hierarchical, component based molecule builder
https://mbuild.mosdef.org
Other
171 stars 79 forks source link

Added extensions to savers doc string #1146

Closed CalCraven closed 11 months ago

CalCraven commented 11 months ago

PR Summary:

Add more doc strings to be explicit about saving out compounds into various formats.

PR Checklist


codecov[bot] commented 11 months ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (468028b) 87.12% compared to head (74f6c88) 87.12%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1146 +/- ## ======================================= Coverage 87.12% 87.12% ======================================= Files 62 62 Lines 6455 6455 ======================================= Hits 5624 5624 Misses 831 831 ``` | [Files Changed](https://app.codecov.io/gh/mosdef-hub/mbuild/pull/1146?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mosdef-hub) | Coverage Δ | | |---|---|---| | [mbuild/compound.py](https://app.codecov.io/gh/mosdef-hub/mbuild/pull/1146?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mosdef-hub#diff-bWJ1aWxkL2NvbXBvdW5kLnB5) | `97.12% <ø> (ø)` | | | [mbuild/conversion.py](https://app.codecov.io/gh/mosdef-hub/mbuild/pull/1146?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mosdef-hub#diff-bWJ1aWxkL2NvbnZlcnNpb24ucHk=) | `89.40% <ø> (ø)` | |

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