Consistent documentation for each script

[nicolemah99]

• [ ] data_pipeline.sh
• [ ] download.sh
• [ ] ...

Add consistent documentation to each script: Short Option:

#!/bin/bash

# Script: script_name.sh
# Desc: Brief description of the script's purpose.
# Usage: ./script_name.sh param1 param2
# Params: $1 - First parameter (e.g., input file), $2 - Second parameter (optional)
# Returns: Description of return values or output, if any.
# Called by: List of scripts or processes calling this script (if applicable).
# Notes: Additional notes such as dependencies or environment variables.

Long Option:

#!/bin/bash

###########################################################################
# Script Name: script_name.sh
# 
# Description: Briefly describe what this script does, including its overall
#              purpose and any important actions it performs.
# 
# Called By: List the scripts or processes that typically call this script.
#            Example: called by process_data.sh for preprocessing steps.
#
# Parameters: 
#    $1: Description of the first parameter (e.g., input file path)
#    $2: Description of the second parameter (if applicable)
#    ...
#    $N: Description of the Nth parameter (if applicable)
#
# Returns: Describe what the script returns, if anything. This could be an exit
#          status code, output to stdout, or the creation/modification of files.
#          Example: Returns 0 on success, 1 on failure. Outputs processed data
#          to stdout.
#
# Usage: Provide an example of how to run this script, including any required
#        flags or options.
#        Example: ./script_name.sh inputfile.txt outputfile.txt
#
# Notes: Include any additional notes, such as dependencies, required
#        environment variables, or limitations.
#
###########################################################################

# Script content starts here...

What are your thoughts @aloralove ?

[aloralove]

I think thats great! Lets do the long option. @nicolemah99