popsim-consortium / popsim-consortium/stdpopsim
Docs/CLI should list recombination maps in reverse time
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 144
- Forks
- 100
- Avg merge
- 2h 44m
- Merged PRs (30d)
- 2
Description
If a user needs to use a recombination map usually what they want is the most recently defined one. So, documentation should list the maps so that the most recently defined map is listed first, and prominently display the year it was defined. This also goes for the help in the CLI, which should list available recombination maps with a short description of what they are, and their year.
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 with the documentation and CLI entry points that list available recombination maps. Update both listings so maps are ordered newest first and each prominently includes its definition year and a short description; done means the documentation and CLI present the same complete, reverse-chronological information.
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
- 52/100