Reference documentation for types is a bit odd

Aperta
#120 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Confronta il riferimento standard delle credenziali in libgit2.org/docs/reference/main/credential/index.html con il riferimento sys, usando git_credential_username come esempio. Poi esamina libgit2.org/libgit2/index.html e aggiorna i reindirizzamenti insieme alla documentazione di riferimento. Il lavoro è completato quando le informazioni sui tipi pertinenti compaiono nella documentazione regolare delle credenziali e i reindirizzamenti tengono conto della modifica.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
CSS
Stelle
116
Fork
67
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di libgit2/www.libgit2.org

Tutte le issue di libgit2/www.libgit2.org

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.