OpenFreeEnergy / OpenFreeEnergy/openfe
[SepTop] refactor `test_lambda_energies` in `test_septop_slow`
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 331
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
The return for compare_energies is a bit confusing and likely will be hard to remember what's going on in the future. It needs a) more in-line comments, b) moving to a test class fixture to make easier to maintain.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate test_lambda_energies in test_septop_slow and inspect how compare_energies is currently returned and used. Move the relevant setup into a test class fixture, add inline comments explaining the comparison, and run the affected SepTop tests to confirm they still pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing-qa
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100