RDoc formatter hardcoded to darkfish for RubyGems
まだ誰も着手していません。
- 主要言語
- Ruby
- スター
- 930
- フォーク
- 465
- 平均マージ
- 3日 10時間
- マージ済み PR(30日)
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
lib/rdoc/generator/darkfish.rb の 167 行目で報告された失敗から始め、.gemrc を rdoc: -f horo として設定した状態で gem rdoc --rdoc --overwrite rake を実行して再現します。カスタム formatter オプションがどのように RDoc に渡されるかを追跡し、その後、gem rdoc が報告された TypeError なしに formatter を受け付け、要求された formatter を使用することを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- ruby
- 領域
- documentation
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100