Don't include method documentation for aliased methods

Offen
#1,533 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
42/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
ruby
Bereich
documentation

Rechercherichtung

Beginne mit dem im Issue verlinkten Abschnitt des Dokumentationsleitfadens und erzeuge anschließend die generierte Dokumentation für Array#find und Array#detect erneut, um das Verhalten des Alias zu verstehen. Untersuche, wie RDoc aliased methods behandelt, und bestimme, wie ein optionaler Unterdrückungsmodus funktionieren sollte. Die Aufgabe ist abgeschlossen, wenn Aliase keine irreführende doppelte Dokumentation mehr erzeugen, während die Dokumentation der ursprünglichen Methode erhalten bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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)

Vorherrschende Sprache
Ruby
Sterne
930
Forks
472
Ø Merge
2 T. 8 Std.
Gemergte PRs (30 T.)
12

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus ruby/rdoc

Alle Issues in ruby/rdoc

Ähnliche Issues

Weitere Issues zu Ruby

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.