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

rdoc 6.13.1 does not detect `private :new`

Đang mở
  • Có gì không ổn?
#1,364 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
55/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

Bắt đầu với reproducer foo.rb và chạy rdoc để kiểm tra cách private :new được biểu diễn trong tài liệu được tạo. Theo dõi cách parser xử lý khai báo private và xác minh rằng tài liệu được tạo không còn liệt kê phương thức lớp new, trong khi initialize vẫn không được lập tài liệu.

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

Mô tả

I'm not sure if this is a bug report or a feature request; I think it has worked in the past but I'm not sure.

Given an input foo.rb:

# Example Foo class should not document private new
class Foo
  class << self
    private :new
  end

  # This should not be documented
  def initialize(...)
  end
end

The generated documentation should not document the new class method.

Image

I can work around this by adding # :nodoc:, but it feels like something that should be detected by the parser.

I'm updating a gem to be Ruby 3.2+, so if there's a better way to mark a private new in those versions that rdoc does detect, I can use that instead.

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.