Merge pull request #593 from DannyBen/update/default-script-header

Update default script header

examples/catch-all-advanced/README.md

@@ -121,9 +121,10 @@ Examples:
 ### `$ ./cli download source`
 
 ````shell
-# this file is located in 'src/download_command.sh'
-# code for 'cli download' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/download_command.sh'.
+# It contains the implementation for the 'cli download' command.
+# The code you write here will be wrapped by a function named 'cli_download_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[source]} = source
 
@@ -133,9 +134,10 @@ args:
 ### `$ ./cli download source target`
 
 ````shell
-# this file is located in 'src/download_command.sh'
-# code for 'cli download' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/download_command.sh'.
+# It contains the implementation for the 'cli download' command.
+# The code you write here will be wrapped by a function named 'cli_download_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[source]} = source
 - ${args[target]} = target
@@ -146,9 +148,10 @@ args:
 ### `$ ./cli download source target --force`
 
 ````shell
-# this file is located in 'src/download_command.sh'
-# code for 'cli download' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/download_command.sh'.
+# It contains the implementation for the 'cli download' command.
+# The code you write here will be wrapped by a function named 'cli_download_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[--force]} = 1
 - ${args[source]} = source
@@ -160,9 +163,10 @@ args:
 ### `$ ./cli download source target --force -abc --option=value`
 
 ````shell
-# this file is located in 'src/download_command.sh'
-# code for 'cli download' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/download_command.sh'.
+# It contains the implementation for the 'cli download' command.
+# The code you write here will be wrapped by a function named 'cli_download_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[--force]} = 1
 - ${args[source]} = source
@@ -182,9 +186,10 @@ other_args:
 ### `$ ./cli download source target --force -- -abc --option=value`
 
 ````shell
-# this file is located in 'src/download_command.sh'
-# code for 'cli download' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/download_command.sh'.
+# It contains the implementation for the 'cli download' command.
+# The code you write here will be wrapped by a function named 'cli_download_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[--force]} = 1
 - ${args[source]} = source
@@ -233,9 +238,10 @@ usage: cli upload [--] FILES...
 ### `$ ./cli upload file1 "file 2" file3`
 
 ````shell
-# this file is located in 'src/upload_command.sh'
-# code for 'cli upload' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/upload_command.sh'.
+# It contains the implementation for the 'cli upload' command.
+# The code you write here will be wrapped by a function named 'cli_upload_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args: none
 
 other_args:

examples/catch-all-advanced/src/download_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/download_command.sh'"
-echo "# code for 'cli download' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/download_command.sh'."
+echo "# It contains the implementation for the 'cli download' command."
+echo "# The code you write here will be wrapped by a function named 'cli_download_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/catch-all-advanced/src/upload_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/upload_command.sh'"
-echo "# code for 'cli upload' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/upload_command.sh'."
+echo "# It contains the implementation for the 'cli upload' command."
+echo "# The code you write here will be wrapped by a function named 'cli_upload_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/catch-all/README.md

@@ -77,8 +77,10 @@ Arguments:
 ### `$ ./download something`
 
 ````shell
-# this file is located in 'src/root_command.sh'
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/root_command.sh'.
+# It contains the implementation for the 'download' command.
+# The code you write here will be wrapped by a function named 'download_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[message]} = something
 
@@ -88,8 +90,10 @@ args:
 ### `$ ./download something with --additional args`
 
 ````shell
-# this file is located in 'src/root_command.sh'
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/root_command.sh'.
+# It contains the implementation for the 'download' command.
+# The code you write here will be wrapped by a function named 'download_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[message]} = something
 
@@ -105,8 +109,10 @@ other_args:
 ### `$ ./download something --debug -- also pass --debug to catch_all`
 
 ````shell
-# this file is located in 'src/root_command.sh'
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/root_command.sh'.
+# It contains the implementation for the 'download' command.
+# The code you write here will be wrapped by a function named 'download_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[--debug]} = 1
 - ${args[message]} = something

examples/catch-all/src/root_command.sh

@@ -1,3 +1,5 @@
-echo "# this file is located in 'src/root_command.sh'"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/root_command.sh'."
+echo "# It contains the implementation for the 'download' command."
+echo "# The code you write here will be wrapped by a function named 'download_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-aliases/README.md

@@ -141,9 +141,10 @@ Examples:
 ### `$ ./cli d somefile`
 
 ````shell
-# this file is located in 'src/download_command.sh'
-# code for 'cli download' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/download_command.sh'.
+# It contains the implementation for the 'cli download' command.
+# The code you write here will be wrapped by a function named 'cli_download_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[source]} = somefile
 
@@ -212,9 +213,10 @@ Examples:
 ### `$ ./cli push somefile`
 
 ````shell
-# this file is located in 'src/upload_command.sh'
-# code for 'cli upload' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/upload_command.sh'.
+# It contains the implementation for the 'cli upload' command.
+# The code you write here will be wrapped by a function named 'cli_upload_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[source]} = somefile
 

examples/command-aliases/src/download_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/download_command.sh'"
-echo "# code for 'cli download' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/download_command.sh'."
+echo "# It contains the implementation for the 'cli download' command."
+echo "# The code you write here will be wrapped by a function named 'cli_download_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-aliases/src/upload_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/upload_command.sh'"
-echo "# code for 'cli upload' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/upload_command.sh'."
+echo "# It contains the implementation for the 'cli upload' command."
+echo "# The code you write here will be wrapped by a function named 'cli_upload_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-default-force/README.md

@@ -68,9 +68,10 @@ Options:
 ### `$ ./tester`
 
 ````shell
-# this file is located in 'src/all_command.sh'
-# code for 'tester all' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/all_command.sh'.
+# It contains the implementation for the 'tester all' command.
+# The code you write here will be wrapped by a function named 'tester_all_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args: none
 
 
@@ -79,9 +80,10 @@ args: none
 ### `$ ./tester all`
 
 ````shell
-# this file is located in 'src/all_command.sh'
-# code for 'tester all' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/all_command.sh'.
+# It contains the implementation for the 'tester all' command.
+# The code you write here will be wrapped by a function named 'tester_all_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args: none
 
 
@@ -107,9 +109,10 @@ Options:
 ### `$ ./tester only one`
 
 ````shell
-# this file is located in 'src/only_command.sh'
-# code for 'tester only' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/only_command.sh'.
+# It contains the implementation for the 'tester only' command.
+# The code you write here will be wrapped by a function named 'tester_only_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[search]} = one
 

examples/command-default-force/src/all_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/all_command.sh'"
-echo "# code for 'tester all' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/all_command.sh'."
+echo "# It contains the implementation for the 'tester all' command."
+echo "# The code you write here will be wrapped by a function named 'tester_all_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-default-force/src/only_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/only_command.sh'"
-echo "# code for 'tester only' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/only_command.sh'."
+echo "# It contains the implementation for the 'tester only' command."
+echo "# The code you write here will be wrapped by a function named 'tester_only_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-default/README.md

@@ -95,9 +95,10 @@ Options:
 ### `$ ./ftp download something`
 
 ````shell
-# this file is located in 'src/download_command.sh'
-# code for 'ftp download' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/download_command.sh'.
+# It contains the implementation for the 'ftp download' command.
+# The code you write here will be wrapped by a function named 'ftp_download_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[source]} = something
 
@@ -139,9 +140,10 @@ Arguments:
 ### `$ ./ftp upload something`
 
 ````shell
-# this file is located in 'src/upload_command.sh'
-# code for 'ftp upload' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/upload_command.sh'.
+# It contains the implementation for the 'ftp upload' command.
+# The code you write here will be wrapped by a function named 'ftp_upload_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[source]} = something
 
@@ -151,9 +153,10 @@ args:
 ### `$ ./ftp something`
 
 ````shell
-# this file is located in 'src/upload_command.sh'
-# code for 'ftp upload' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/upload_command.sh'.
+# It contains the implementation for the 'ftp upload' command.
+# The code you write here will be wrapped by a function named 'ftp_upload_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args:
 - ${args[source]} = something
 

examples/command-default/src/download_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/download_command.sh'"
-echo "# code for 'ftp download' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/download_command.sh'."
+echo "# It contains the implementation for the 'ftp download' command."
+echo "# The code you write here will be wrapped by a function named 'ftp_download_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-default/src/upload_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/upload_command.sh'"
-echo "# code for 'ftp upload' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/upload_command.sh'."
+echo "# It contains the implementation for the 'ftp upload' command."
+echo "# The code you write here will be wrapped by a function named 'ftp_upload_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-examples-on-error/src/download_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/download_command.sh'"
-echo "# code for 'cli download' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/download_command.sh'."
+echo "# It contains the implementation for the 'cli download' command."
+echo "# The code you write here will be wrapped by a function named 'cli_download_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-examples-on-error/src/upload_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/upload_command.sh'"
-echo "# code for 'cli upload' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/upload_command.sh'."
+echo "# It contains the implementation for the 'cli upload' command."
+echo "# The code you write here will be wrapped by a function named 'cli_upload_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-examples/src/download_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/download_command.sh'"
-echo "# code for 'cli download' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/download_command.sh'."
+echo "# It contains the implementation for the 'cli download' command."
+echo "# The code you write here will be wrapped by a function named 'cli_download_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-examples/src/upload_command.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/upload_command.sh'"
-echo "# code for 'cli upload' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/upload_command.sh'."
+echo "# It contains the implementation for the 'cli upload' command."
+echo "# The code you write here will be wrapped by a function named 'cli_upload_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-filenames/README.md

@@ -107,9 +107,10 @@ Options:
 ### `$ ./cli dir list`
 
 ````shell
-# this file is located in 'src/dir_commands/list.sh'
-# code for 'cli dir list' goes here
-# you can edit it freely and regenerate (it will not be overwritten)
+# This file is located at 'src/dir_commands/list.sh'.
+# It contains the implementation for the 'cli dir list' command.
+# The code you write here will be wrapped by a function named 'cli_dir_list_command()'.
+# Feel free to edit this file; your changes will persist when regenerating.
 args: none
 
 

examples/command-filenames/src/dir_commands/list.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/dir_commands/list.sh'"
-echo "# code for 'cli dir list' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/dir_commands/list.sh'."
+echo "# It contains the implementation for the 'cli dir list' command."
+echo "# The code you write here will be wrapped by a function named 'cli_dir_list_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-filenames/src/dir_commands/remove.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/dir_commands/remove.sh'"
-echo "# code for 'cli dir remove' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/dir_commands/remove.sh'."
+echo "# It contains the implementation for the 'cli dir remove' command."
+echo "# The code you write here will be wrapped by a function named 'cli_dir_remove_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args

examples/command-filenames/src/file_commands/edit.sh

@@ -1,4 +1,5 @@
-echo "# this file is located in 'src/file_commands/edit.sh'"
-echo "# code for 'cli file edit' goes here"
-echo "# you can edit it freely and regenerate (it will not be overwritten)"
+echo "# This file is located at 'src/file_commands/edit.sh'."
+echo "# It contains the implementation for the 'cli file edit' command."
+echo "# The code you write here will be wrapped by a function named 'cli_file_edit_command()'."
+echo "# Feel free to edit this file; your changes will persist when regenerating."
 inspect_args