Don't include method documentation for aliased methods

Ouverte
#1,533 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
42/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
ruby
Domaine
documentation

Piste de recherche

Commencez par la section du guide de documentation liée dans l’issue, puis reproduisez la documentation générée de Array#find et Array#detect afin de comprendre le comportement de l’alias. Examinez la façon dont RDoc gère les aliased methods et déterminez comment un mode facultatif de suppression devrait fonctionner. Le travail est terminé lorsque les alias ne produisent plus de documentation dupliquée trompeuse, tandis que la méthode d’origine reste documentée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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)

Langage dominant
Ruby
Étoiles
930
Forks
472
Merge moyen
2 j 8 h
PR mergées (30 j)
12

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de ruby/rdoc

Toutes les issues de ruby/rdoc

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.