ruby / ruby/delegate

SimpleDelegator documentation missing in ruby-docs.org

オープン
#5 コメント 3 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Ruby
スター
25
フォーク
14
平均マージ
8時間 41分
マージ済み PR(30日)
1

説明

Since 3.0.0, the library documentation is only partially rendered. Neither SimpleDelegator nor
the DelegateClass kernel method appear in the documentation.

https://ruby-doc.org/stdlib-3.0.0/libdoc/delegate/rdoc/Delegator.html
https://ruby-doc.org/stdlib-3.0.1/libdoc/delegate/rdoc/Delegator.html
https://ruby-doc.org/stdlib-3.0.2/libdoc/delegate/rdoc/Delegator.html

I'm not sure if splitting it into one file per top-level definition would solve it, but it might be the case that ruby-docs does not support several top-level definitions in the same file?

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、delegate 3.0.0 から 3.0.2 までのリンク先の ruby-docs.org ページを比較し、次に delegate ライブラリのトップレベル定義がどのように出力されるかを調べます。生成されたドキュメントに SimpleDelegator と DelegateClass Kernel メソッドが現れれば、作業は完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
ruby
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。