OpenFreeEnergy / OpenFreeEnergy/openfe

MD Protocol filename getters should be plural

Open
#1,080 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
331
Forks
56
Avg merge
3d 9h
Merged PRs (30d)
13

Description

I just noticed the getters for the PlainMDProtocolResult aren't plural but they return up to several names (i.e. a list of names).

We should check if we need to rename them.

Contributor guide

Open the 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.

Research direction

Start by locating PlainMDProtocolResult and identify the filename getters that return lists of names. Check their usages and existing tests before deciding whether plural names are needed; done means the naming decision is applied consistently without breaking callers or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.