<see langword="..."/> renders as nothing in API docs

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#1,370 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
fsharp
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với phần xử lý see và seealso trong src/FSharp.Formatting.ApiDocs/XmlDocReader.fs, ở dòng 193–213. Kiểm tra cách trình đọc xử lý cref và cách các phần tử c trở thành mã nội dòng, sau đó lần theo các kiểm thử tài liệu API liên quan. Hoàn thành khi các giá trị langword như true được hiển thị dưới dạng mã nội dòng thay vì biến mất.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

XmlDocReader renders a <see> or <seealso> element only when it has a cref attribute (XmlDocReader.fs#L193-L213). <see langword="true"/>, the .NET way to reference a keyword, has no cref, so the word is lost: /// <summary>Returns <see langword="true"/> when the event has at least one handler.</summary> renders as "Returns when the event has at least one handler." The expected output is the keyword as inline code, the same as <c>true</c>.

FSharp.Core starts to use langword in dotnet/fsharp#20940, so its API reference shows the gap.

Ngôn ngữ chính
F#
Star
492
Fork
160
Merge trung bình
3 ngày 2 giờ
Pull request đã merge (30 ngày)
7

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của fsprojects/FSharp.Formatting

Tất cả issue của fsprojects/FSharp.Formatting

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.