RDoc formatter hardcoded to darkfish for RubyGems
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Ruby
- Estrellas
- 930
- Forks
- 465
- Merge medio
- 3 d 10 h
- PR fusionados (30 d)
- 27
Descripción
It seems that RDoc is not currently designed to allow a custom formatter when running gem rdoc. Even when using .gemrc and setting the --format option to a custom formatter (like horo) seems to not work. In fact, in the latest version of RDoc (6.0.4), any attempt to use a custom formatter via .gemrc causes a crash:
$ gem rdoc --rdoc --overwrite rake
Parsing documentation for rake-12.3.1
Installing ri documentation for rake-12.3.1
ERROR: While executing gem ... (TypeError)
no implicit conversion of nil into String
My .gemrc file:
rdoc: -f horo
I traced the TypeError exception to here: https://github.com/ruby/rdoc/blob/master/lib/rdoc/generator/darkfish.rb#L167
Thanks in advance.
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.
Línea de trabajo
Comienza con el fallo indicado en lib/rdoc/generator/darkfish.rb en la línea 167 y reprodúcelo ejecutando gem rdoc --rdoc --overwrite rake con .gemrc configurado como rdoc: -f horo. Traza cómo llega a RDoc la opción del formatter personalizado y, después, verifica que gem rdoc acepte el formatter sin el TypeError indicado y utilice el formatter solicitado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- ruby
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100