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

How to handle tool-specific magic comments

Đang mở
  • Có gì không ổn?
#1,614 1 bình luận 2 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
ruby
Lĩnh vực
documentation

Hướng nghiên cứu

Issue không nêu tệp triển khai hay bài kiểm thử nào. Hãy tái hiện ví dụ bằng RDoc, sau đó theo dõi cách xử lý shebang và các comment ma thuật của Ruby, rồi so sánh với các comment dành riêng cho công cụ như # typed: true và # rbs_inline: enabled. Hoàn thành khi các comment đó không còn xuất hiện dưới dạng tài liệu cấp cao nhất mà không làm hỏng hành vi hiện có của RDoc đối với comment ma thuật.

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

Mô tả

rdoc currently removes shebangs and ruby magic comments from rendered documetantion.

But other tools like sorbet and rbs-inline provide their own comments like # typed: true or rbs_inline: enabled which aren't excluded. If I have a file like this:

# frozen_string_literal: true
# rbs_inline: enabled
# :markup: markdown

module Prism
  module Foo
    # ...
  end
end

Then for each file, you get one rbs_inline comment on the top-level namespace. I feel like either rdoc should

  • ignore any magic-style comment, regardless of if it is "official" or not
  • Not attach comments where there is whitespace before the top-level. I guess this is not feasable for backwards compat since rdoc itself makes heavy use of that style.

This can be worked around by inserting #-- before the magic comments but I don't think I should need to care about this at all.

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.