style(bktemp-updateLoopPI):add function comment

[BK-2020-03.git] / unitproc / bktemp-dateShort

diff --git a/unitproc/bktemp-dateShort b/unitproc/bktemp-dateShort
index b4e4464e8b62bf915180c4366adfdf13f9d3039c..5757eae859c8961c5cc528bb9d68877b49777b5a 100644 (file)
--- a/unitproc/bktemp-dateShort
+++ b/unitproc/bktemp-dateShort
@@ -1,5 +1,4 @@
 #!/bin/bash
-
 # Desc: Template to display date
 
 yell() { echo "$0: $*" >&2; }      #o Yell, Die, Try Three-Fingered Claw technique
@@ -8,33 +7,33 @@ try() { "$@" || die "cannot $*"; } #o
 dateShort(){
     # Desc: Date without separators (YYYYmmdd)
     # Usage: dateShort ([str date])
-    # Version: 1.1.0
+    # Version: 1.1.2
     # Input: arg1: 'date'-parsable timestamp string (optional)
     # Output: stdout: date (ISO-8601, no separators)
-    # Depends: yell
-    local TIME_CURRENT DATE_CURRENT_SHORT
+    # Depends: bash 5.0.3, date 8.30, yell()
+    local argTime timeCurrent timeInput dateCurrentShort
 
     argTime="$1";
     # Get Current Time
-    TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
+    timeCurrent="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
     # Decide to parse current or supplied date
     ## Check if time argument empty
     if [[ -z "$argTime" ]]; then
        ## T: Time argument empty, use current time
-       TIME_INPUT="$TIME_CURRENT";
+       timeInput="$timeCurrent";
     else
        ## F: Time argument exists, validate time
        if date --date="$argTime" 1>/dev/null 2>&1; then
            ### T: Time argument is valid; use it
-           TIME_INPUT="$argTime";
+           timeInput="$argTime";
        else
            ### F: Time argument not valid; exit
            yell "ERROR:Invalid time argument supplied. Exiting."; exit 1;
-       fi
-    fi
+       fi;
+    fi;
     # Construct and deliver separator-les date string    
-    DATE_CURRENT_SHORT="$(date -d "$TIME_INPUT" +%Y%m%d)"; # Produce separator-less current date with resolution 1 day.
-    echo "$DATE_CURRENT_SHORT";
+    dateCurrentShort="$(date -d "$timeInput" +%Y%m%d)"; # Produce separator-less current date with resolution 1 day.
+    echo "$dateCurrentShort";
 } # Get YYYYmmdd
 
 #==BEGIN sample code==