RDoc formatter hardcoded to darkfish for RubyGems
還沒有人認領這個 Issue。
- 主要語言
- Ruby
- 星號
- 930
- 分支
- 465
- 平均合併
- 3 天 10 小時
- 30 天內合併 PR
- 27
描述
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.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 lib/rdoc/generator/darkfish.rb 第 167 行回報的失敗開始,透過在將 .gemrc 設定為 rdoc: -f horo 的情況下執行 gem rdoc --rdoc --overwrite rake 來重現該失敗。追蹤自訂 formatter 選項如何傳遞至 RDoc,然後驗證 gem rdoc 能接受該 formatter,而不會出現回報的 TypeError,並使用要求的 formatter。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- ruby
- 領域
- documentation
- Issue 類型
- 缺陷
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100