RDoc needs a directive to not clobber an overridden method definition's documentation, but add to it.
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
- 45/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- Calme
- Stack technique
- ruby
- Domaine
- documentation
Piste de recherche
Commencez par suivre la manière dont RDoc gère la documentation des méthodes redéfinies et la manière dont les directives existantes sont représentées. Définissez le comportement de la directive autour de l’exemple Kernel.require, puis ajoutez une couverture montrant que la documentation d’origine est conservée et que la documentation de la méthode redéfinissante est ajoutée au lieu de la remplacer.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
RDoc needs a directive to not clobber an overridden method definition's documentation, but add to it.
Use case: I wanted to find out how require worked.
Unfortunately, in RDoc-generated documentation, all I could find is information on how by requiring rubygems the behavior of Kernel.require changed, but nothing about its original behavior.
If RDoc had a directive to add, don't replace documentation, and it was used on the rubygems' monkeypatch of Kernel.require, the original documentation wouldn't have gotten lost.
- Langage dominant
- Ruby
- Étoiles
- 927
- Forks
- 467
- Merge moyen
- 1 j 2 h
- PR mergées (30 j)
- 19
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 40 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
-
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 5 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
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de ruby/rdoc
Issues similaires
-
kotlin-lsp is missingOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
JetBrains/homebrew-utils#21 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
ublue-os/homebrew-experimental-tap#774 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
r-uby-dev/llm#251 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
accessibility
Difficulté 1/5 Moins d'une heure Accessibilité débutants 72/100
slovensko-digital/ops-portal#212 ·
Les mainteneurs répondent en général sous 1 jour
-
Don't expose useless actions....Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100