OpenFreeEnergy / OpenFreeEnergy/gufe
Mapping should default to None in Protocol methods
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 45
- Forks
- 13
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 3
Description
As of 1.7, mappings are not used in the majority of our Protocols. I realise that the intent is that Transformations just deal with the user facing parts of the API, but we also often have examples that just have users call Protocol.create directly. In those cases, it doesn't make a ton of sense to have to pass mapping=None when it is only necessary for a few Protocols.
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 locating the Protocol methods whose signatures require a mapping argument, then inspect the surrounding Protocol implementations and direct-call examples. Update the relevant defaults so callers can omit mapping where appropriate, and verify that existing Protocol usage and the examples still work without explicitly passing mapping=None.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100