lsegal/yard — Issue #458: Three "Returns" for two `@overload` tags
Author: gioele
Created: 2012-01-13 14:31:28+00:00
State: open

The following comment and code generate a three "Returns" sections.

# @overload heading?(text)
# @return whether the file heading matches the given text
#
# @overload heading?
# @return whether the file has an heading

def heading?(text = nil)
…
end

The first two "Returns" section are for the overloads and they say

> Returns:
> * whether the file heading matches the given text
>
> Returns:
> * whether the file has an heading

The last "Returns" section has no text and contains only the return type

> Returns:
> * (Boolean)

I suppose that only two Returns sections should be generated and each should have, by default, the deduced Boolean type.