Alias for attribute causes aliasing method to appear in Attributes section
Les mainteneurs répondent en général sous 1 jour
@extern-c y travaille déjà.
Depuis le 24/2/2025.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 45/100
- Type d'issue
- Bug
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- ruby
- Domaine
- documentation
Piste de recherche
Commencez par le comportement de RDoc décrit pour lib/foo.rb et exécutez rdoc sur l’exemple contenant attr :bar et alias baz bar. Inspectez la documentation Foo générée ; le travail est terminé lorsque baz n’apparaît plus dans la section attributes, tandis que bar reste documenté.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
When defining an alias for an attribute in a class, the aliasing method is incorrectly displayed in the attributes section of the generated documentation.
For example, consider the following code in lib/foo.rb:
class Foo
attr :bar
alias baz bar
end
When running rdoc, the documentation for the Foo class shows:
This behavior is misleading, as baz is not a separate attribute but an alias method for bar method (and attribute). It would be beneficial to adjust the documentation generation to prevent alias methods from appearing in the attributes section.
- Langage dominant
- Ruby
- Étoiles
- 927
- Forks
- 467
- Merge moyen
- 23 h 47 min
- 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
-
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 44 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
-
Regexp generated from unescaped input in #expand_classPeut-être pris @jaynetics l’a pris il y a 3 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
-
enhancement
Difficulté 4/5 3-5 jours Accessibilité débutants 68/100
ruby/rdoc#1823 · 5 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Wrong heading levels in generated HTML?Peut-être pris @st0012 l’a pris il y a 9 jours. Ouvertebug
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
ruby/rdoc#1822 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de ruby/rdoc
Issues similaires
-
ETQ admin, le select de condition d'une annotation répétable liste les champs publics deux foisOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
demarche-numerique/demarche.numerique.gouv.fr#14301 ·
Les mainteneurs répondent en général sous 1 jour
-
needs verification
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
Les mainteneurs répondent en général sous 6 jours
-
L: java:gradle L: java:maven L: ruby:bundler T: bug 🐞
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
dependabot/dependabot-core#16547 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 8 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour