Skip to content

Commit 3cc02e7

Browse files
docs(scripts/utils.inc): clarify documentation
1 parent 79592ce commit 3cc02e7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

scripts/utils.inc

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# 0. Set the current directory to the directory of the script. By this
1616
# the script can be called from anywhere.
1717
# 1. Parse the named arguments
18-
# 2. If the parameter "git_push_dryrun" is set, all calls the `git push` in this script
18+
# 2. If the parameter "git_push_dryrun" is set, all calls to `git push` in this script
1919
# or in child scripts will be intercepted so that the `--dry-run` and `--porcelain` is added
2020
# to show what the push would do but not actually do it.
2121
# 3. If the parameter "verbose" is set, the `-x` flag will be set in bash.
@@ -36,7 +36,7 @@
3636
# with the name of the parameter in upper case (with dash converted to underscore).
3737
#
3838
# Special arguments that are always available:
39-
# - "--action=.*": This parameter will be used to dispatch to a function with that name when the
39+
# - "--action=.*": This parameter will be used to execute a function with that name when the
4040
# script is started
4141
# - "--git_push_dryrun=true": This will intercept all calls to `git push` in this script
4242
# or in child scripts so that the `--dry-run` and `--porcelain` is added
@@ -195,7 +195,7 @@ function isFunction {
195195
}
196196

197197
# readJsonProp(jsonFile, property)
198-
# - restriction: property needs to be on an own line!
198+
# - restriction: property needs to be on a single line!
199199
function readJsonProp {
200200
echo $(sed -En 's/.*"'$2'"[ ]*:[ ]*"(.*)".*/\1/p' $1)
201201
}

0 commit comments

Comments
 (0)