The method `getMapping` is neither tested nor used in the gufe bindings, but is used in the examples

Open
  • Is something wrong?
#68 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
backend, documentation, testing

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.

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.

Dominant language
Python
Stars
45
Forks
15
Avg merge
18h 11m
Merged PRs (30d)
4

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenFreeEnergy/Lomap

All issues in OpenFreeEnergy/Lomap

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.