protocolbuffers / protocolbuffers/protocolbuffers.github.io
C++ API docs out of date?
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- HTML
- Star
- 69
- Fork
- 179
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
The C++ API documentation does not appear to mirror the new absl::string_view return types introduced in v30.
https://protobuf.dev/support/migration/#string_view-return-type - describes the change in return types
https://protobuf.dev/reference/cpp/api-docs/google.protobuf.descriptor/#Descriptor - indicates returning const std::string&
https://github.com/protocolbuffers/protobuf/blob/01331f9e51775b7e11f8b61d778ea98ddb522ad1/src/google/protobuf/descriptor.h#L362 - returns absl::string_view
Hướng dẫn đóng góp
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
So sánh hướng dẫn di chuyển với tài liệu API C++ cho trang Descriptor và dòng 362 được tham chiếu trong descriptor.h. Xác minh những kiểu trả về nào được ghi trong tài liệu khác với các signature v30 sử dụng absl::string_view, cập nhật tài liệu API bị ảnh hưởng và xác nhận rằng các trang nhất quán phản ánh header.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- cpp
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- 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
- 45/100