0

Using the ruby Yard doc tool I can write

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

however if the parameter is an enumerable

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

Is the above the correct way or not?

bradgonesurfing
  • 30,949
  • 17
  • 114
  • 217

1 Answers1

3

Do it like this:

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

Reference: http://rubydoc.info/docs/yard/file/docs/GettingStarted.md#Declaring_Types

Jacob Lukas
  • 689
  • 6
  • 14