Documenting `Data` classes
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- ruby
- Área
- documentation
Línea de trabajo
Comience reproduciendo los ejemplos documentados con rdoc, con y sin el analizador Prism, para Data.define, Struct.new y la reapertura de la clase generada. Rastree cómo se clasifican estas definiciones y verifique que la clase y sus métodos se documenten como una clase, mientras que no se conserva la documentación obsoleta de Object.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
rdoc does not usefully document data classes defined the correct way:
# Documenting a class made with Data.define
MyDataClass = Data.define :a do
# Capitalize the value of +a+.
def cap
a.capitalize
end
end
This documents a constant on Object, Object::MyDataClass instead of documenting it as a class itself, and the method within the data class definition is not documented either. It does not matter whether the Prism parser is used.
When documented with reopening, there are two different issues
MyDataClass = Data.define :a # :nodoc:
# Documenting a class made with Data.define
class MyDataClass
# Capitalize the value of +a+.
def cap
a.capitalize
end
end
If defined without # :nodoc:, MyDataClass is still documented as a constant on Object; if defined with # :nodoc:, the documentation is removed, but the generated documentation pages for Object isn't removed.
I believe that Data.define and Struct.new should be treated as if they were written as class variants.
- Lenguaje dominante
- Ruby
- Estrellas
- 929
- Forks
- 469
- Merge medio
- 1 d 2 h
- PR fusionados (30 d)
- 19
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
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 documentationPosiblemente ocupada @OskarEichler la tomó hace 36 días. Abierto
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
-
Wrong heading levels in generated HTML?Posiblemente ocupada @st0012 la tomó hace 2 días. Abiertobug
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
ruby/rdoc#1822 · 2 comentarios ·
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 76/100
rubys/roundhouse#444 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
sclorg/s2i-ruby-container#656 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
request
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
endoflife-date/endoflife.date#11277 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
yegor256/rubocop-elegant#92 ·