minor doc added

[feisty_meow.git] / scripts / core / functions.sh

diff --git a/scripts/core/functions.sh b/scripts/core/functions.sh
index c5a4f87daa7cc153a4d3d471a9c0d6e70e80ac67..463be9e066ab76d30541ba606e38bb62e9a6ce7b 100644 (file)
--- a/scripts/core/functions.sh
+++ b/scripts/core/functions.sh
@@ -76,6 +76,7 @@ if [ -z "$skip_all" ]; then
   # makes the status of pipe number N (passed as first parameter) into the
   # main return value (i.e., the value for $?).  this is super handy to avoid
   # repeating the awkward looking code below in multiple places.
+  # the numbering starts at zero, for the first item at the head of the pipe.
   function promote_pipe_return()
   {
     ( exit ${PIPESTATUS[$1]} )