OpenFreeEnergy / OpenFreeEnergy/Lomap
The method `getMapping` is neither tested nor used in the gufe bindings, but is used in the examples
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 45
- Forks
- 16
- Avg merge
- 55m
- Merged PRs (30d)
- 1
Description
As pointed out here (https://github.com/OpenFreeEnergy/Lomap/issues/60) , this method is not being tested, but is being used in examples (e.g. here https://github.com/OpenFreeEnergy/Lomap/blob/500028a95278f3afafeaaf820ce714456ab02b43/examples/example.py#L34-L38)
We should think about either removing the method (which is not used in the gufe_bindings) and update docs accordingly or keep it and add tests for it.
Contributor guide
No contributing guide indexed for this repository
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
Start by inspecting getMapping in the gufe bindings and its use in examples/example.py, including the referenced example lines. Determine whether the method should be removed or retained; done means either updating the documentation and examples after removal, or adding coverage for the method and keeping the examples consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, documentation, testing
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100