Bash_Scripts/Templates/Functions/Function-Docstring.example

13 lines
225 B
Plaintext
Raw Permalink Normal View History

2021-07-28 09:32:08 -05:00
# What the function does
#
# Arguments:
# arg1 <type: string> <position: 1> <required: true>
# - An example argument
#
# Usage:
# functionName "hello"
# - Makes arg1 equal to "hello"
#
# POSIX Compliant:
# Yes
#