OpenFreeEnergy / OpenFreeEnergy/openfe
[docs] + [cli] openfe atommapping
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 331
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
The CLI has an atommapping option which seems to no longer be advertised in when calling openfe --help.
However it is present in the docs: https://docs.openfree.energy/en/latest/guide/cli/cli_basics.html
- Should
atommapingbe including in the help message? (I haven't seen a commit that specifically seemed to try to remove it) - If yes - let's add it back
- If no - let's update the docs accordingly
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
Start by running openfe --help and compare its options with the CLI documentation at https://docs.openfree.energy/en/latest/guide/cli/cli_basics.html. Determine whether atommapping is intended to remain supported, then either make the help output and documentation consistent. Done means the option has the same status and spelling in both places.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100