rdoc, darkfish и тег: call-seq:

Question

Я нахожусь в процессе документирования проекта Ruby с помощью rdoc, и я обнаружил форматировщик темных рыб rdoc.Мне действительно это нравится, но тег :call-seq: больше не работает.Вместо этого он помещает буквальную строку :call-seq: в документацию, а затем форматирует саму последовательность вызовов в виде блока кода.Я не хочу просто удалять все блоки: call-seq: из моего кода, поскольку большая часть моей документации должна ссылаться на имена экземпляров и имена параметров, указанные в блоке :call-seq:.У кого-нибудь еще возникла такая проблема?Что мне делать, и есть ли обходной путь?Я почти уверен, что тег :call-seq: работал раньше, когда я использовал форматтер по умолчанию, но я не уверен, потому что не могу понять, как вернуться к генерации оригинального формата (вызывая rdoc без аргументовкроме файлов теперь генерирует вывод darkfish, даже если я удаляю папку doc!) Кто-нибудь знает, как это исправить?

Answer 1

Я настоятельно рекомендую перейти от rdoc к YARD . Он не поддерживает сам старый call-seq, но вместо этого у него есть теги, и в особенности тег @ overload лучше заменит call-seq. Вся документация на rubydoc.info также генерируется с использованием YARD.

Вот пример @overload из документации YARD:

# @overload set(key, value)
#   Sets a value on key
#   @param [Symbol] key describe key param
#   @param [Object] value describe value param
# @overload set(value)
#   Sets a value on the default key `:foo`
#   @param [Object] value describe value param
def set(*args)
end