RDoc: Modifier le nom de la section 'Atttributes:' dans la documentation ri
-
11-07-2019 - |
Question
J'utilise une méta-programmation pour générer un tas de méthodes en ruby ??comme ceci:
class EmotionalObject
def self.mood( name, *details )
define_method(name) do
# ...
end
end
mood :happy, #...
mood :sad, #...
mood :ebuillent, #...
#...
end
Je sais que je peux passer rdoc
"-Un état d'humeur" pour qu'il puisse reconnaître mon état d'esprit.
code de génération en tant qu'attributs, ce qui est pratique, car au moins ils
être reconnu.
Cependant, elles ressemblent beaucoup plus à des méthodes régulières qu'à des attributs, donc
Je ne veux pas qu'ils figurent dans la section "Attributs:" lorsque je regarde
dans la documentation avec ri
. Je n'ai pas d'attributs réguliers,
alors est-il possible de changer simplement le titre de cette section en "Moods:"
ou quelque chose comme ça, donc mes utilisateurs sont au moins assez curieux pour taper ri EmotionalObject # happy
.
La solution
Il est codé en dur dans les modèles RDoc, mais vous pouvez créer un nouveau modèle à utiliser en dupliquant le paramètre par défaut " html " modèle et changer le nom de la rubrique à la main.
Voir la source du modèle RDoc ici: http://github.com/juretta/ruby/blob/master/lib/rdoc/generator/html/html.rb#L601 .
Autres conseils
Il semble que quelque part autour de rdoc 2.4.1, ils ont supprimé - accessor
et l'ont remplacé par l'utilisation de ##
commentaires sur chaque méta-méthode. Bien que cela vous permette de les sortir de la section d'attributs, cela vous oblige également à les commenter individuellement.