Closed synthead closed 1 week ago
The general approach here would be the same as the case where you have a *args
or **kwargs
method-- you would use @overload
to define a synthesized method signature:
# @overload my_method(a, b)
# @param a [String] the first parameter
# @param b [Boolean] the second parameter
def my_method(...) = other(...)
Ruby 2.7 introduces argument forwarding, which looks like this:
If argument forwarding is used with YARD, one might attempt to document their methods like this:
However, when
yardoc
is ran with the above code, it raises this warning:How should the above code be documented with YARD?