Skip to content

Clean up README and docstrings#435

Draft
epretti wants to merge 1 commit intoopenmm:mainfrom
epretti:update-readme-docstring
Draft

Clean up README and docstrings#435
epretti wants to merge 1 commit intoopenmm:mainfrom
epretti:update-readme-docstring

Conversation

@epretti
Copy link
Copy Markdown
Member

@epretti epretti commented Apr 1, 2026

Updates/removes some outdated information. Per #434, the documentation for SystemGenerator should reflect the fact that template generators might take more than just a string to specify a force field. Also, passing in objects other than Molecules was never supported, and this has already been removed from other docstrings, so it's removed in SystemGenerator as well.

The README also referred to some outdated information including ancient versions of OpenMM, and should now reflect that 8.5 will be required. This PR shouldn't be merged until the 8.5.1 patch release is out.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 1, 2026

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.73%. Comparing base (7b765ec) to head (ba45a36).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #435   +/-   ##
=======================================
  Coverage   84.73%   84.73%           
=======================================
  Files           5        5           
  Lines         799      799           
=======================================
  Hits          677      677           
  Misses        122      122           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants