Skip to content

Commit 1db7847

Browse files
DannyBenDannyBen
authored
Merge pull request #593 from DannyBen/update/default-script-header
Update default script header
2 parents 1da194d + c85276c commit 1db7847

File tree

140 files changed

+861
-584
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

140 files changed

+861
-584
lines changed

‎examples/catch-all-advanced/README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,10 @@ Examples:
121121
### `$ ./cli download source`
122122

123123
````shell
124-
# this file is located in 'src/download_command.sh'
125-
# code for 'cli download' goes here
126-
# you can edit it freely and regenerate (it will not be overwritten)
124+
# This file is located at 'src/download_command.sh'.
125+
# It contains the implementation for the 'cli download' command.
126+
# The code you write here will be wrapped by a function named 'cli_download_command()'.
127+
# Feel free to edit this file; your changes will persist when regenerating.
127128
args:
128129
- ${args[source]} = source
129130

@@ -133,9 +134,10 @@ args:
133134
### `$ ./cli download source target`
134135

135136
````shell
136-
# this file is located in 'src/download_command.sh'
137-
# code for 'cli download' goes here
138-
# you can edit it freely and regenerate (it will not be overwritten)
137+
# This file is located at 'src/download_command.sh'.
138+
# It contains the implementation for the 'cli download' command.
139+
# The code you write here will be wrapped by a function named 'cli_download_command()'.
140+
# Feel free to edit this file; your changes will persist when regenerating.
139141
args:
140142
- ${args[source]} = source
141143
- ${args[target]} = target
@@ -146,9 +148,10 @@ args:
146148
### `$ ./cli download source target --force`
147149

148150
````shell
149-
# this file is located in 'src/download_command.sh'
150-
# code for 'cli download' goes here
151-
# you can edit it freely and regenerate (it will not be overwritten)
151+
# This file is located at 'src/download_command.sh'.
152+
# It contains the implementation for the 'cli download' command.
153+
# The code you write here will be wrapped by a function named 'cli_download_command()'.
154+
# Feel free to edit this file; your changes will persist when regenerating.
152155
args:
153156
- ${args[--force]} = 1
154157
- ${args[source]} = source
@@ -160,9 +163,10 @@ args:
160163
### `$ ./cli download source target --force -abc --option=value`
161164

162165
````shell
163-
# this file is located in 'src/download_command.sh'
164-
# code for 'cli download' goes here
165-
# you can edit it freely and regenerate (it will not be overwritten)
166+
# This file is located at 'src/download_command.sh'.
167+
# It contains the implementation for the 'cli download' command.
168+
# The code you write here will be wrapped by a function named 'cli_download_command()'.
169+
# Feel free to edit this file; your changes will persist when regenerating.
166170
args:
167171
- ${args[--force]} = 1
168172
- ${args[source]} = source
@@ -182,9 +186,10 @@ other_args:
182186
### `$ ./cli download source target --force -- -abc --option=value`
183187

184188
````shell
185-
# this file is located in 'src/download_command.sh'
186-
# code for 'cli download' goes here
187-
# you can edit it freely and regenerate (it will not be overwritten)
189+
# This file is located at 'src/download_command.sh'.
190+
# It contains the implementation for the 'cli download' command.
191+
# The code you write here will be wrapped by a function named 'cli_download_command()'.
192+
# Feel free to edit this file; your changes will persist when regenerating.
188193
args:
189194
- ${args[--force]} = 1
190195
- ${args[source]} = source
@@ -233,9 +238,10 @@ usage: cli upload [--] FILES...
233238
### `$ ./cli upload file1 "file 2" file3`
234239

235240
````shell
236-
# this file is located in 'src/upload_command.sh'
237-
# code for 'cli upload' goes here
238-
# you can edit it freely and regenerate (it will not be overwritten)
241+
# This file is located at 'src/upload_command.sh'.
242+
# It contains the implementation for the 'cli upload' command.
243+
# The code you write here will be wrapped by a function named 'cli_upload_command()'.
244+
# Feel free to edit this file; your changes will persist when regenerating.
239245
args: none
240246

241247
other_args:

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

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

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

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

‎examples/catch-all/README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,10 @@ Arguments:
7777
### `$ ./download something`
7878

7979
````shell
80-
# this file is located in 'src/root_command.sh'
81-
# you can edit it freely and regenerate (it will not be overwritten)
80+
# This file is located at 'src/root_command.sh'.
81+
# It contains the implementation for the 'download' command.
82+
# The code you write here will be wrapped by a function named 'download_command()'.
83+
# Feel free to edit this file; your changes will persist when regenerating.
8284
args:
8385
- ${args[message]} = something
8486

@@ -88,8 +90,10 @@ args:
8890
### `$ ./download something with --additional args`
8991

9092
````shell
91-
# this file is located in 'src/root_command.sh'
92-
# you can edit it freely and regenerate (it will not be overwritten)
93+
# This file is located at 'src/root_command.sh'.
94+
# It contains the implementation for the 'download' command.
95+
# The code you write here will be wrapped by a function named 'download_command()'.
96+
# Feel free to edit this file; your changes will persist when regenerating.
9397
args:
9498
- ${args[message]} = something
9599

@@ -105,8 +109,10 @@ other_args:
105109
### `$ ./download something --debug -- also pass --debug to catch_all`
106110

107111
````shell
108-
# this file is located in 'src/root_command.sh'
109-
# you can edit it freely and regenerate (it will not be overwritten)
112+
# This file is located at 'src/root_command.sh'.
113+
# It contains the implementation for the 'download' command.
114+
# The code you write here will be wrapped by a function named 'download_command()'.
115+
# Feel free to edit this file; your changes will persist when regenerating.
110116
args:
111117
- ${args[--debug]} = 1
112118
- ${args[message]} = something

‎examples/catch-all/src/root_command.sh

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

‎examples/command-aliases/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,10 @@ Examples:
141141
### `$ ./cli d somefile`
142142

143143
````shell
144-
# this file is located in 'src/download_command.sh'
145-
# code for 'cli download' goes here
146-
# you can edit it freely and regenerate (it will not be overwritten)
144+
# This file is located at 'src/download_command.sh'.
145+
# It contains the implementation for the 'cli download' command.
146+
# The code you write here will be wrapped by a function named 'cli_download_command()'.
147+
# Feel free to edit this file; your changes will persist when regenerating.
147148
args:
148149
- ${args[source]} = somefile
149150

@@ -212,9 +213,10 @@ Examples:
212213
### `$ ./cli push somefile`
213214

214215
````shell
215-
# this file is located in 'src/upload_command.sh'
216-
# code for 'cli upload' goes here
217-
# you can edit it freely and regenerate (it will not be overwritten)
216+
# This file is located at 'src/upload_command.sh'.
217+
# It contains the implementation for the 'cli upload' command.
218+
# The code you write here will be wrapped by a function named 'cli_upload_command()'.
219+
# Feel free to edit this file; your changes will persist when regenerating.
218220
args:
219221
- ${args[source]} = somefile
220222

‎examples/command-aliases/src/download_command.sh

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

‎examples/command-aliases/src/upload_command.sh

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

‎examples/command-default-force/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,10 @@ Options:
6868
### `$ ./tester`
6969

7070
````shell
71-
# this file is located in 'src/all_command.sh'
72-
# code for 'tester all' goes here
73-
# you can edit it freely and regenerate (it will not be overwritten)
71+
# This file is located at 'src/all_command.sh'.
72+
# It contains the implementation for the 'tester all' command.
73+
# The code you write here will be wrapped by a function named 'tester_all_command()'.
74+
# Feel free to edit this file; your changes will persist when regenerating.
7475
args: none
7576

7677

@@ -79,9 +80,10 @@ args: none
7980
### `$ ./tester all`
8081

8182
````shell
82-
# this file is located in 'src/all_command.sh'
83-
# code for 'tester all' goes here
84-
# you can edit it freely and regenerate (it will not be overwritten)
83+
# This file is located at 'src/all_command.sh'.
84+
# It contains the implementation for the 'tester all' command.
85+
# The code you write here will be wrapped by a function named 'tester_all_command()'.
86+
# Feel free to edit this file; your changes will persist when regenerating.
8587
args: none
8688

8789

@@ -107,9 +109,10 @@ Options:
107109
### `$ ./tester only one`
108110

109111
````shell
110-
# this file is located in 'src/only_command.sh'
111-
# code for 'tester only' goes here
112-
# you can edit it freely and regenerate (it will not be overwritten)
112+
# This file is located at 'src/only_command.sh'.
113+
# It contains the implementation for the 'tester only' command.
114+
# The code you write here will be wrapped by a function named 'tester_only_command()'.
115+
# Feel free to edit this file; your changes will persist when regenerating.
113116
args:
114117
- ${args[search]} = one
115118

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

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

0 commit comments

Comments
 (0)