libgit2 / libgit2/www.libgit2.org

Reference documentation for types is a bit odd

Ouverte
#120 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
CSS
Étoiles
116
Forks
67
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

There are a few examples where we expose the type details in sys but also have it opaque in the regular public docs. For example, git_credential_username.

In these cases, we don't provide any information about the type in the standard credential docs, only in sys. We should do better.

I would expect to see something here: https://libgit2.org/docs/reference/main/credential/index.html

Instead, I only see it here: https://libgit2.org/docs/reference/main/sys/credential/index.html

When we fix this, we need to update the redirects in libgit2.org/libgit2/index.html to account for it

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

Comparez la référence standard des identifiants sur libgit2.org/docs/reference/main/credential/index.html avec la référence sys, en utilisant git_credential_username comme exemple. Examinez ensuite libgit2.org/libgit2/index.html et mettez à jour les redirections en même temps que la documentation de référence. Le travail est considéré comme terminé lorsque les informations de type pertinentes apparaissent dans la documentation standard des identifiants et que les redirections prennent en compte la modification.

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

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
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.