Don't include method documentation for aliased methods
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
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de ruby/rdoc
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationPeut-être pris @OskarEichler l’a pris il y a 80 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
ruby/rdoc#1759 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
markdown html excerpt includes link partsPeut-être pris @anyingiit l’a pris il y a 26 jours. Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 66/100
Les mainteneurs répondent en général sous 1 jour
-
Regexp generated from unescaped input in #expand_classPeut-être pris @jaynetics l’a pris il y a 39 jours. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 25/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de ruby/rdoc
Issues similaires
-
Pro request form loses all text when the subject is too longPeut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouvertebug f:request-creation professional
Difficulté 2/5 1-3 heures Accessibilité débutants 64/100
mysociety/alaveteli#9733 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
needs verification
Difficulté 2/5 1-3 heures Accessibilité débutants 64/100
Les mainteneurs répondent en général sous 13 jours
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
betagouv/conseillers-entreprises#4808 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100