libgit2 / libgit2/rugged

No documentation for sort modes

Ouverte
#653 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
C
Étoiles
2.3k
Forks
293
Métriques de merge des PR
Aucune PR mergée en 30 j

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?

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par lire la documentation de la classe Walker et repérez les définitions ou les références existantes à Rugged::SORT_NONE, SORT_TOPO et aux autres modes de tri. Documentez la signification de chaque option et l’endroit où les options sont exposées ; l’issue est terminée lorsque les utilisateurs peuvent trouver une explication claire de tous les modes de tri.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
ruby
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.