libgit2 / libgit2/www.libgit2.org
Reference documentation for types is a bit odd
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- CSS
- Estrellas
- 116
- Forks
- 67
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Compara la referencia estándar de credenciales en libgit2.org/docs/reference/main/credential/index.html con la referencia de sys, usando git_credential_username como ejemplo. Después inspecciona libgit2.org/libgit2/index.html y actualiza las redirecciones junto con la documentación de referencia. Se considera terminado cuando la información de tipos relevante aparece en la documentación normal de credenciales y las redirecciones tienen en cuenta el cambio.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100