No documentation for sort modes
Open
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 2.3k
- Forks
- 293
- PR merge metrics
- No merged PRs in 30d
Description
I haven't seen any clear documentation on the sort mode options, i.e. Rugged::SORT_{NONE,TOPO,...}. Could this please be mentioned somewhere, perhaps in the Walker class docs?
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 reading the Walker class documentation and locating the definitions or existing references for Rugged::SORT_NONE, SORT_TOPO, and the other sort modes. Document what each option means and where the options are exposed; the issue is done when users can find a clear explanation of all sort modes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100