Mention of deprecated symbols in 101 samples
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the 101 samples page, especially the repositories_clone_progress example, and compare its symbols with the libgit2 reference search. Investigate whether deprecated names can be detected reliably from the deprecated header. Done means the affected samples are identified and a maintainable approach for handling them is documented.
Written by the indexing model from the issue text.
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 ?
- Dominant language
- CSS
- Stars
- 116
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from libgit2/www.libgit2.org
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
libgit2/www.libgit2.org#120 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
libgit2/www.libgit2.org#117 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
libgit2/www.libgit2.org#99 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
libgit2/www.libgit2.org#96 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
libgit2/www.libgit2.org#70 ·
All issues in libgit2/www.libgit2.org
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·