RDoc: изменить имя раздела «Атрибуты:» в документации по ri
-
11-07-2019 - |
Вопрос
Я использую метапрограммирование для генерации нескольких методов в ruby, например так:
class EmotionalObject
def self.mood( name, *details )
define_method(name) do
# ...
end
end
mood :happy, #...
mood :sad, #...
mood :ebuillent, #...
#...
end
Я знаю, что могу передать rdoc
'-A настроение', чтобы он узнал мое настроение
генерация кода в качестве атрибутов, что удобно, с тех пор они как минимум
получить признание.
Однако они действительно больше похожи на обычные методы, чем на атрибуты, поэтому
Я не хочу, чтобы они отображались в разделе «Атрибуты:», когда я смотрю
в документации, используя ri
. У меня нет никаких обычных атрибутов,
так есть ли какой-нибудь простой способ, которым я могу просто изменить название этого раздела на «Настроение:»
или что-то в этом роде, поэтому мои пользователи, по крайней мере, достаточно любопытны, чтобы набрать ri EmotionalObject # happy
.
Решение
Он жестко запрограммирован в шаблонах RDoc, но вы можете создать новый шаблон для использования, продублировав стандартный " html " шаблон и изменение названия заголовка вручную.
Другие советы
Похоже, что где-то в rdoc 2.4.1 они удалили - accessor
и заменили его, используя ##
комментарии к каждому мета-методу. Хотя это позволяет вам выводить их из раздела атрибутов, оно также заставляет вас комментировать каждый из них по отдельности.