rdoc 6.13.1 does not detect `private :new`
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 55/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- ruby
- Área
- documentation
Línea de trabajo
Comienza con el reproductor foo.rb y ejecuta rdoc para inspeccionar cómo se representa private :new en la documentación generada. Sigue el procesamiento de la declaración privada por parte del parser y verifica que la documentación generada ya no incluya el método de clase new, mientras que initialize permanece sin documentar.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Ruby
- Estrellas
- 930
- Forks
- 465
- Merge medio
- 2 d 16 h
- PR fusionados (30 d)
- 28
Preparar el entorno
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de ruby/rdoc
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
ruby/rdoc#1759 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 68/100
ruby/rdoc#1823 · 5 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Los mantenedores suelen responder en 1 día
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
misa.G should not be definedAbiertodata error
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
riscv/riscv-unified-db#2648 ·
Los mantenedores suelen responder en 1 día
-
P2 testing
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
Los mantenedores suelen responder en 1 día