libgit2 / libgit2/www.libgit2.org
Reference documentation for types is a bit odd
Nessuno ha ancora preso questa issue.
- Lingua principale
- CSS
- Stelle
- 116
- Fork
- 67
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
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
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
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.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100