Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Adding YARD document support to RDoc

Đang mở
  • Có gì không ổn?
#1,344 12 bình luận 4 reaction 0 người được giao Xem trên GitHub

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

@okuramasafumi đang làm issue này rồi.

Từ ngày 27/8/2025.

  • #1416 của @okuramasafumi — đang mở

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
ruby
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách xem xét pull request #1321 và cuộc thảo luận được liên kết để hiểu tại sao cách tiếp cận plugin bị hoãn lại. Sử dụng mục roadmap đầu tiên chưa được đánh dấu để xác định một đóng góp có phạm vi tập trung; việc hoàn thành nên bao quát một khả năng YARD đã được thống nhất, chẳng hạn như framework cơ bản hoặc một tag được liệt kê, thay vì toàn bộ tập hợp tính năng.

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

Mô tả

Background

I implemented a plugin system for RDoc in https://github.com/ruby/rdoc/pull/1321 and YARD parsing plugin is implemented.
In the discussion with @st0012, @kou and @vinistock we decided that we should implement YARD parsing feature as a standalone feature without plugin.
The note exists in https://github.com/ruby/rdoc/discussions/1257#discussioncomment-12882912

Steps

There are some steps to have effective YARD parsing feature in RDoc.

  • Adding basic framework to support YARD style document (RDoc::Yard class or similar)
  • Adding support of YARD tags that already works with current RDoc such as @yield and @private
    • @yield
    • @private
  • Adding support of YARD tags that needs simple modification of RDoc such @deprecated
    • Adding :deprecated directive
    • Adding @deprecated
  • Adding features such as type support to utilize information from YARD
    • @return
    • @param
    • others (will be edited later)
  • Adding support of YARD directives and macros
    • @!attribute
    • others (will be edited later)

I will implement these step by step.

Note

The idea of plugin system is not completely abandoned but postponed.

Ngôn ngữ chính
Ruby
Star
927
Fork
467
Merge trung bình
23 giờ 47 phút
Pull request đã merge (30 ngày)
12

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 ruby/rdoc

Tất cả issue của ruby/rdoc

Issue tương tự

Thêm issue về Ruby

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.