libgit2 / libgit2/www.libgit2.org
Mention of deprecated symbols in 101 samples
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
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 ?
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la 101 samples page, en particulier par le repositories_clone_progress example, et comparez ses symboles avec la libgit2 reference search. Examinez si les deprecated names peuvent être détectés de manière fiable à partir du deprecated header. Le travail est considéré comme terminé lorsque les samples concernés sont identifiés et qu’une approche maintenable pour les gérer est documentée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100