Para tags are mangled when explicitly declared in remarks in combination with new-lines
- Ngôn ngữ chính
- C#
- Star
- 14
- Fork
- 21
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
See https://github.com/dotnet/runtime/blob/925205d06d82ce5e0d24e4e313fd66887fe89795/src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/CollectionsMarshal.cs#L50-L60
This produced escaped para tags that required fixup https://github.com/dotnet/dotnet-api-docs/commit/88e32343860fb4f40d147a602f982f753bbaa027#diff-f01295b45b7c030a49d50f0e76b8ffb9e41e3c2238ae1bc6097cc1b781570ad5L61
We should investigate what's going wrong and fix the tool
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
Hướng nghiên cứu
Bắt đầu bằng cách so sánh các ghi chú trong CollectionsMarshal.cs ở dòng 50-60 với thay đổi api-docs được tạo đã liên kết trong issue. Theo dõi cách công cụ documentation-sync xử lý các para tags được khai báo rõ ràng và các dòng mới. Hoàn thành khi công cụ không còn phát ra escaped para tags cần được sửa thủ công.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- csharp
- Lĩnh vực
- documentation, tooling
- Loại issue
- Lỗi
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 35/100