update systems and components docs for completeness#1954
update systems and components docs for completeness#1954
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1954 +/- ##
==========================================
- Coverage 94.78% 90.51% -4.28%
==========================================
Files 210 210
Lines 18841 18841
==========================================
- Hits 17859 17054 -805
- Misses 982 1787 +805
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
hannahbaumann
left a comment
There was a problem hiding this comment.
Thanks @atravitz , lgtm! Just the one comment!
| Component | ||
| SmallMoleculeComponent | ||
| ProteinComponent | ||
| ProteinMembraneComponent |
There was a problem hiding this comment.
We should probably also add SolvatedPDBComponent here.
There was a problem hiding this comment.
SolvatedPDBComponent is only in gufe, and hasn't been explicitly exposed as openfe.SolvatedPDBComponent. Do you think it would be useful to be user-facing, or keep it in gufe as developer-facing-only?
There was a problem hiding this comment.
note: I've added openfe.SolvatedPDBComponent since I we are referencing it in #1933, which makes it inherently user-facing. Let me know if you disagree!
|
No API break detected ✅ |
I noticed we don't have all relevant components in the api docs, so I added them here.
Might help with #1933
Checklist
newsentry, or the changes are not user-facing.pre-commit.ci autofix.Manual Tests: these are slow so don't need to be run every commit, only before merging and when relevant changes are made (generally at reviewer-discretion).
Developers certificate of origin