Re: [gentoo-dev] [PATCH 1/3] rebar.eclass: fix @RETURN argument

[Ulrich Mueller]

>>>>> On Mon, 12 Apr 2021, Florian Schmaus wrote:

> -# @RETURN: full path with EPREFIX to a Erlang package/project on success,
> -# code 1 when dependency is not found and code 2 if multiple versions of
> -# dependency are found.
> +# @RETURN: full path with EPREFIX to Erlang package/project on success, code 1 when dependency is not found and code 2 if multiple versions of dependency are found.

I think the cure is worse than the disease here.

That @RETURN is supposed to be in one line means that it should be short
(otherwise it would be read as a paragraph). Any lenghty description
belongs in @DESCRIPTION instead.

Also, the "full path" is the function's output, not its return value.

So, suggestion:
# @RETURN: 0 success, 1 dependency not found, 2 multiple versions found

(and the rest can go into @DESCRIPTION).

Ulrich