RDoc: изменить имя раздела «Атрибуты:» в документации по ri - PullRequest
1 голос
/ 28 ноября 2008

Я использую метапрограммирование для генерации нескольких методов в ruby, например:

class EmotionalObject
  def self.mood( name, *details )
    define_method(name) do
      # ...
    end
  end

  mood :happy, #...
  mood :sad, #...
  mood :ebuillent, #...
  #...
 end

Я знаю, что могу передать rdoc «-настроение», чтобы оно узнало мое настроение генерация кода в качестве атрибутов, что удобно, с тех пор они как минимум получить признание.

Однако они действительно больше похожи на обычные методы, чем на атрибуты, поэтому Я не хочу, чтобы они отображались в разделе «Атрибуты:», когда я смотрю в документации, используя ri. У меня нет никаких обычных атрибутов, так есть ли какой-нибудь простой способ, которым я могу просто изменить название этого раздела на «Настроение:» или что-то в этом роде, так что мои пользователи, по крайней мере, достаточно любопытны, чтобы напечатать ri EmotionalObject#happy.

Ответы [ 2 ]

1 голос
/ 24 декабря 2009

Похоже, что где-то около rdoc 2.4.1 они удалили --accessor и заменили его, используя ## комментарии к каждому мета-методу. Хотя это позволяет вам выводить их из раздела атрибутов, оно также заставляет вас комментировать каждый из них по отдельности.

http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html

1 голос
/ 29 января 2009

Он жестко запрограммирован в шаблоны RDoc, но вы можете создать новый шаблон для использования, продублировав шаблон "html" по умолчанию и изменив название заголовка вручную.

См. Источник шаблона RDoc здесь: http://github.com/juretta/ruby/blob/master/lib/rdoc/generator/html/html.rb#L601.

...