Stale code comments found while writing the format docs

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#167 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
82/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với RecordFileWriter.Write, RecordField.ContentMediaType, MarkdownDiagnosticIds, ADR 0032, ADR 0029 và README; PR #166 cung cấp bối cảnh cho tài liệu định dạng. Đối chiếu từng chú thích và từng phát biểu trong tài liệu với hành vi của mã được mô tả trong issue, bao gồm issue riêng về dạng clipboard. Hoàn tất khi cả bốn mô tả lỗi thời đều khớp với hành vi hiện tại.

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

Mô tả

The code is right in each case; only the comments are wrong.

  1. RecordFileWriter.Write's summary says every rich value is a |- block, but under R-8 fields of paragraphs are written with |.
  2. RecordField.ContentMediaType's comment says references are text/x-fieldworks-markdown, but the code returns text/x-fieldworks-markdown-inline. Record the -inline type in ADR 0032 as well.
  3. MarkdownDiagnosticIds says link.ambiguous and link.broken are 'reported by hosts', but ObjectBuilder emits both.
  4. ADR 0029 and the README say the Markdown library 'will provide' the FieldWorks Markdown clipboard form. Only the id constant exists; see the separate issue for the form itself.
    Found by the format-docs work (PR #166).
Ngôn ngữ chính
C#
Star
0
Fork
0
Merge trung bình
1 giờ 43 phút
Pull request đã merge (30 ngày)
43

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 sillsdev/SIL.TextEditing

Tất cả issue của sillsdev/SIL.TextEditing

Issue tương tự

Thêm issue về C#

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.