Rdoc: Как документировать различные формы для метода с (* args) подписью?

Question

Я хочу документировать некоторые методы в своем коде Ruby, где методы имеют сигнатуру (* args). Фактический вызов метода может содержать две или три разные формы. Я хотел бы задокументировать эти различные формы, чтобы они появились в RDoc.

* 1003 Е.Г. *

def doit(*args)

Результирующий RDoc должен показывать:

doit (время, место) => логическое значение, doit (что) => массив

вместо фактической подписи метода.

Answer 1

Похоже, директива call-seq: является ответом.

Я вижу множество предложений использовать вместо этого YARD с тегом @overload, который выполняет ту же цель.