RDoc needs a directive to not clobber an overridden method definition's documentation, but add to it.
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Stack tecnológico
- ruby
- Área
- documentation
Línea de trabajo
Comienza rastreando cómo RDoc gestiona la documentación de los métodos sobrescritos y cómo se representan las directivas existentes. Define el comportamiento de la directiva en torno al ejemplo Kernel.require y, a continuación, añade cobertura que demuestre que la documentación original se conserva y que la documentación del método sobrescrito se añade en lugar de reemplazarla.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Ruby
- Estrellas
- 927
- Forks
- 467
- 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 39 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 4 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
-
Local evaluation buckets percentage splits with the server key, so results differ from FlagsmithAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
主催者以外（未ログイン含む）でもイベントを中止できてしまうAbiertobug priority: high
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
mitakarb/beerkeeper#1259 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día