OpenFreeEnergy / OpenFreeEnergy/openfe
rewrite rbfe/rhfe cli docstrings
Open
Nobody has claimed this yet.
cli
documentation
- Dominant language
- Python
- Stars
- 331
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
this whole docstring deviates quite a bit from the rbfe docstring - do we want these to be more parallel in structure?
Originally posted by @atravitz in https://github.com/OpenFreeEnergy/openfe/pull/1265#discussion_r2069608123
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
Locate the rbfe and rhfe CLI docstrings and compare their structure, using the rbfe docstring as the reference mentioned in the issue. Done means the two docstrings are parallel in structure while accurately describing their respective commands.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100