No documentation for sort modes
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- C
- Sterne
- 2.3k
- Forks
- 293
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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?
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Lesen der Dokumentation der Klasse Walker und ermittle die Definitionen oder vorhandenen Verweise auf Rugged::SORT_NONE, SORT_TOPO und die anderen Sortiermodi. Dokumentiere, was jede Option bedeutet und wo die Optionen verfügbar sind; das Issue ist abgeschlossen, wenn Benutzer eine klare Erklärung aller Sortiermodi finden können.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- ruby
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100