Re: [gentoo-dev] [PATCH 1/3] rebar.eclass: fix @RETURN argument
> 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 signature.asc Description: PGP signature
[gentoo-dev] [PATCH 1/3] rebar.eclass: fix @RETURN argument
Previously "pkgcheck scan rebar.class" would complain about
EclassDocError: rebar: failed parsing eclass docs: '@RETURN:', line 61:
non-inline arg
Signed-off-by: Florian Schmaus
---
eclass/rebar.eclass | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/eclass/rebar.eclass b/eclass/rebar.eclass
index 7f712905c407..88c9ca74be73 100644
--- a/eclass/rebar.eclass
+++ b/eclass/rebar.eclass
@@ -53,9 +53,7 @@ get_erl_libs() {
# @FUNCTION: _rebar_find_dep
# @INTERNAL
# @USAGE:
-# @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.
# @DESCRIPTION:
# Find a Erlang package/project by name in Erlang lib directory. Project
# directory is usually suffixed with version. It is matched to ''
--
2.30.2
