Как использовать Yard для документирования перечислимых типов и типов, которые они содержат?

Question

Используя инструмент ruby ​​Yard doc, я могу написать

# @param bar [String]
def foo(bar)
end

, однако, если параметр является перечислимым

# @param bar [Enumerable[String]]
def foo(bar)
end

Правильно ли указано выше или нет?

Answer 1

Сделайте так:

# @param [Enumerable<String>] bar
def foo(bar)
end

Ссылка: http://rubydoc.info/docs/yard/file/docs/GettingStarted.md#Declaring_Types