From 99f4d8ac5da8f18e437668626bd4b532734bf14c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Luc=C3=ADa=20Andrea=20Illanes=20Albornoz?= Date: Mon, 20 Mar 2023 18:08:31 +0100 Subject: Use "Returns:" vs. "Return:" in function documentation. --- subr.ex/ex_pkg_env.subr | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'subr.ex/ex_pkg_env.subr') diff --git a/subr.ex/ex_pkg_env.subr b/subr.ex/ex_pkg_env.subr index 2f394e5b..a177f6d2 100644 --- a/subr.ex/ex_pkg_env.subr +++ b/subr.ex/ex_pkg_env.subr @@ -9,7 +9,7 @@ # @_pkg_name: single package name # @_workdir: pathname to build-specific temporary directory # -# Return: zero (0) on success, non-zero (>0) on failure +# Returns: zero (0) on success, non-zero (>0) on failure # exp_pkg_env_defaults() { local _epped_build_steps_default="${1}" _epped_pkg_name="${2}" _epped_workdir="${3}"; @@ -65,7 +65,7 @@ exp_pkg_env_defaults() { # build group, package to inherit from if any, or package for a single named # package, and exports variables optionally named in ${PKG_ENV_VARS_EXTRA}. # -# Return: zero (0) on success, non-zero (>0) on failure +# Returns: zero (0) on success, non-zero (>0) on failure # exp_pkg_env_set() { local _eppes_build_vars_default="${1}" _eppes_group_name="${2}" _eppes_pkg_name="${3}" \ @@ -108,7 +108,7 @@ exp_pkg_env_set() { # @_restart_at: optional comma-separated list of build steps at which to rebuild or ALL or LAST # @_workdir: pathname to build-specific temporary directory # -# Return: zero (0) on success, non-zero (>0) on failure +# Returns: zero (0) on success, non-zero (>0) on failure # ex_pkg_env() { local _epe_build_steps_default="${1}" _epe_build_vars_default="${2}" \ @@ -152,7 +152,7 @@ ex_pkg_env() { # @_build_step: build step set status of # [@${@}]: optional list of build steps to invalidate status of # -# Return: zero (0) on success, non-zero (>0) on failure +# Returns: zero (0) on success, non-zero (>0) on failure # ex_pkg_state_set() { rtl_state_set "${BUILD_WORKDIR}" "${@}"; @@ -170,7 +170,7 @@ ex_pkg_state_set2() { # @_build_step: build step to test status of # @_restart_at: optional comma-separated list of build steps at which to rebuild or ALL or LAST # -# Return: zero (0) on success, non-zero (>0) on failure +# Returns: zero (0) on success, non-zero (>0) on failure # ex_pkg_state_test() { rtl_state_test "${BUILD_WORKDIR}" "${@}"; -- cgit v1.2.3