RDoc: Cambiar el nombre de la sección 'Atributos:' en la documentación de ri
-
11-07-2019 - |
Pregunta
Estoy usando algo de metaprogramación para generar un montón de métodos en ruby ??así:
class EmotionalObject
def self.mood( name, *details )
define_method(name) do
# ...
end
end
mood :happy, #...
mood :sad, #...
mood :ebuillent, #...
#...
end
Sé que puedo pasar rdoc
'-A mood' para que reconozca mi estado de ánimo
código de generación como atributos, lo cual es útil, ya que al menos
ser reconocido.
Sin embargo, en realidad son más como métodos regulares que como atributos, así que
No quiero que aparezcan en la sección 'Atributos:' cuando miro
en la documentación usando ri
. No tengo atributos regulares,
Entonces, ¿hay alguna manera simple de cambiar el título de esta sección para que sea 'Moods'?
o algo así, por lo que mis usuarios son al menos lo suficientemente curiosos como para escribir ri EmocionalObjeto # feliz
.
Solución
Está codificado en las plantillas RDoc, pero puede crear una nueva plantilla para usar duplicando el predeterminado '' html '' plantilla y cambiando el nombre del encabezado a mano.
Vea la fuente de la plantilla RDoc aquí: http://github.com/juretta/ruby/blob/master/lib/rdoc/generator/html/html.rb#L601 .
Otros consejos
Parece que en algún lugar alrededor de rdoc 2.4.1 eliminaron --accessor
y lo reemplazaron con el uso de ##
comentarios en cada meta-método. Si bien esto le permite sacarlos de la sección de atributos, también lo obliga a comentar cada uno individualmente.