rdoc 6.13.1 does not detect `private :new`
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 55/100
- Type d'issue
- Bug
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- ruby
- Domaine
- documentation
Piste de recherche
Commencez avec le reproducteur foo.rb et exécutez rdoc pour examiner comment private :new est représenté dans la documentation générée. Suivez le traitement de la déclaration privée par le parser et vérifiez que la documentation générée ne répertorie plus la méthode de classe new, tandis que initialize reste non documenté.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
I'm not sure if this is a bug report or a feature request; I think it has worked in the past but I'm not sure.
Given an input foo.rb:
# Example Foo class should not document private new
class Foo
class << self
private :new
end
# This should not be documented
def initialize(...)
end
end
The generated documentation should not document the new class method.
I can work around this by adding # :nodoc:, but it feels like something that should be detected by the parser.
I'm updating a gem to be Ruby 3.2+, so if there's a better way to mark a private new in those versions that rdoc does detect, I can use that instead.
- Langage dominant
- Ruby
- Étoiles
- 930
- Forks
- 465
- Merge moyen
- 2 j 16 h
- PR mergées (30 j)
- 28
Préparer son environnement
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 documentationOuverte
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
-
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
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
-
security
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
OSCON 2016Ouvertecontent
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
rubyevents/rubyevents#2148 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
we-promise/sure#3838 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Mend: dependency security vulnerability
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
ManageIQ/manageiq-ui-classic#10341 ·
Les mainteneurs répondent en général sous 1 jour
-
Obsolete link to RubyMine docsOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
rubocop/ruby-style-guide#984 ·