libgit2 / libgit2/www.libgit2.org
Mention of deprecated symbols in 101 samples
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
Hello,
I am starting to learn the libgit2 API and in the first example I wanted to try I stumbled upon git_indexer_progress: https://libgit2.org/docs/guides/101-samples/#repositories_clone_progress.
Unfortunately, this does not appear anywhere in the reference: https://libgit2.org/libgit2/#HEAD/search/git_transfer_progress.
Further investigation showed that it is simply because it is a deprecated name of git_indexer_progress.
So, I will definitely do a PR for this particular instance, but it would be nice to be able to catch all such symbols automatically if possible.
Do you think there would be a reliable way to do so, or we should try to parse the "deprecated" header ?
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
Comienza con la 101 samples page, especialmente con el repositories_clone_progress example, y compara sus símbolos con la libgit2 reference search. Investiga si los deprecated names se pueden detectar de forma fiable a partir del deprecated header. Se considera terminado cuando se hayan identificado los samples afectados y se haya documentado un enfoque mantenible para gestionarlos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100