From bb73b3c4702b9e1751d2b94cd3bfdebfc2b8746c Mon Sep 17 00:00:00 2001
From: Chris Koeritz <cak0l@virginia.edu>
Date: Thu, 18 Nov 2021 09:00:24 -0500
Subject: [PATCH] minor doc added

---
 scripts/core/functions.sh | 1 +
 1 file changed, 1 insertion(+)

diff --git a/scripts/core/functions.sh b/scripts/core/functions.sh
index c5a4f87d..463be9e0 100644
--- 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]} )
-- 
2.34.1