Don't include method documentation for aliased methods

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

メンテナーはふだん 1 日以内に返信

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
42/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
ruby
領域
documentation

調査の方向性

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

環境構築

はじめの一歩

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

ruby/rdoc のほかの issue

ruby/rdoc の issue をすべて見る

似ている issue

Ruby の issue をもっと見る

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

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