RDoc formatter hardcoded to darkfish for RubyGems
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Ruby
- Star
- 930
- Fork
- 465
- Merge trung bình
- 3 ngày 10 giờ
- Pull request đã merge (30 ngày)
- 27
Mô tả
It seems that RDoc is not currently designed to allow a custom formatter when running gem rdoc. Even when using .gemrc and setting the --format option to a custom formatter (like horo) seems to not work. In fact, in the latest version of RDoc (6.0.4), any attempt to use a custom formatter via .gemrc causes a crash:
$ gem rdoc --rdoc --overwrite rake
Parsing documentation for rake-12.3.1
Installing ri documentation for rake-12.3.1
ERROR: While executing gem ... (TypeError)
no implicit conversion of nil into String
My .gemrc file:
rdoc: -f horo
I traced the TypeError exception to here: https://github.com/ruby/rdoc/blob/master/lib/rdoc/generator/darkfish.rb#L167
Thanks in advance.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với lỗi được báo cáo tại dòng 167 của lib/rdoc/generator/darkfish.rb và tái hiện lỗi đó bằng cách chạy gem rdoc --rdoc --overwrite rake với .gemrc được cấu hình là rdoc: -f horo. Theo dõi cách tùy chọn formatter tùy chỉnh được truyền đến RDoc, sau đó xác minh rằng gem rdoc chấp nhận formatter mà không gặp TypeError đã được báo cáo và sử dụng formatter được yêu cầu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- ruby
- Lĩnh vực
- documentation
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100