YARD documentation for splat (lists) as parameters

B

bwv549

[I am using YARD to document my code. I'm new to YARD, but I've read
through the documentation and didn't see this: ]

How do I properly document splat lists?

The method I'm thinking about takes an arbitrary list of ruby
Objects. Here is what I'm thinking:

# @param [*Array] objects A list of objects
# @param [*Objects] objects A list of objects
# @param [*Objects] objects A splat list of objects

Any advice/direction is greatly appreciated!
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

No members online now.

Forum statistics

Threads
474,432
Messages
2,571,682
Members
48,796
Latest member
Greg L.

Latest Threads

Top