chore(user/zeropad.sh):Add some comments

diff --git a/user/zeropad.sh b/user/zeropad.sh
index 369d8c06ca771433319a22e6150520084a601415..761fd3051eeb283bdbb00f6403638750dc32a378 100755 (executable)
--- a/user/zeropad.sh
+++ b/user/zeropad.sh
@@ -4,8 +4,12 @@
 # Version: 0.0.4
 
 list_files() {
 # Version: 0.0.4
 
 list_files() {

+    # Desc: Lists working directory file basenames
+    # Usage: list_files
+    # Input: none
+    # Output: stdout  a line-delimited list of file names

     find . -mindepth 1 -maxdepth 1 -type f -exec basename '{}' \; ;
     find . -mindepth 1 -maxdepth 1 -type f -exec basename '{}' \; ;

-};
+}; # list pwd file basenames

 main () {
     # Find the maximum number of leading digits in the filenames of working dir
     max_digits="$(list_files | sed -e 's/[^0-9].*//' | awk '{ if(length > L) L=length } END { print L }')";
 main () {
     # Find the maximum number of leading digits in the filenames of working dir
     max_digits="$(list_files | sed -e 's/[^0-9].*//' | awk '{ if(length > L) L=length } END { print L }')";


@@ -26,12 +30,9 @@ main () {
         mv -n "$file" "$new_file"
         # declare -p file new_file; # debug
     done < <(list_files);
         mv -n "$file" "$new_file"
         # declare -p file new_file; # debug
     done < <(list_files);

-};
+}; # main program

 
 main "$@";
 
 
 main "$@";
 

-
-
-

 # Author: Steven Baltakatei Sandoval
 # License: GPLv3+
 # Author: Steven Baltakatei Sandoval
 # License: GPLv3+