Ruby's :yields:

Question

I was looking through some tab-completions that were automatically set up for my editor, and I found one where y was mapped to:

:yields: arguments

What is this syntax called, when, where, how and for what is this used?

Answer 1

This is one of the many directives supported by the RDoc documentation tool. It is used to document the arguments that get passed to a block.