From: bwv549 on 3 Aug 2010 15:40 [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!
|
Pages: 1 Prev: documenting string Next: undefined method `debug' for nil:NilClass(NoMethodError |