libgit2 / libgit2/www.libgit2.org
Mention of deprecated symbols in 101 samples
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- CSS
- Star
- 116
- Fork
- 67
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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 ?
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với 101 samples page, đặc biệt là repositories_clone_progress example, và so sánh các symbol của nó với libgit2 reference search. Điều tra xem có thể phát hiện deprecated names một cách đáng tin cậy từ deprecated header hay không. Công việc được xem là hoàn tất khi các samples bị ảnh hưởng đã được xác định và một cách tiếp cận dễ bảo trì để xử lý chúng đã được ghi lại.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100