PEtab-dev / PEtab-dev/petab_select
Add CLI to docs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 14
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Might be difficult to maintain comprehensive docs, but can at least say something like
See the CLI notebook, and
petab_select --help.
so people know where the "comprehensive" docs can be found.
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 reviewing the CLI notebook and running petab_select --help to confirm where users find comprehensive guidance. Update the documentation to point to both resources, and consider the issue done when readers are directed to the notebook and help output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100