Don't include method documentation for aliased methods
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 42/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- ruby
調査の方向性
Issue でリンクされているドキュメントガイドのセクションから始め、次に生成された Array#find と Array#detect のドキュメントを再現して、alias の動作を理解します。RDoc が aliased methods をどのように扱うかを調べ、オプションの抑制モードがどのように機能すべきかを判断します。元のメソッドのドキュメントを残したまま、alias が誤解を招く重複ドキュメントを生成しなくなれば完了です。
索引モデルが issue の本文から書いたものです。
説明
In Ruby, the documentation guide states:
Omit aliases from the
call-seq, unless the alias is an operator method.
This is intended prevent documentation duplication and have the reader read the documentation for the original method. However, this leads to all of the aliases to not have call-seq so the method appears to accept no arguments and is misleading to the reader (e.g. Array#find and the alias Array#detect appears to take no arguments).
I think RDoc should (at least have the option to) avoid generating documentation for aliased methods.
(This discussion originated from https://github.com/ruby/ruby/pull/15756)
- 主要言語
- Ruby
- スター
- 930
- フォーク
- 472
- 平均マージ
- 2日 8時間
- マージ済み PR(30日)
- 12
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ruby/rdoc のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentation対応中かも @OskarEichler が 80 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
markdown html excerpt includes link parts対応中かも @anyingiit が 26 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
Regexp generated from unescaped input in #expand_class対応中かも @jaynetics が 39 日前に担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 25/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
bug f:request-creation professional
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
mysociety/alaveteli#9733 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
needs verification
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
メンテナーはふだん 13 日以内に返信
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
betagouv/conseillers-entreprises#4808 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100