Skip to content

Commit 8f5aca6

Browse files
committed
improve documentation and echo exit status
1 parent de3f4ea commit 8f5aca6

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

dev/test_scripts_help.sh

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,17 @@
33
# Ensure each script can display help message to ensure basic execution.
44
#
55
# This script must be run from within the pipenv shell or a properly configured
6-
# environment.
6+
# environment. For example:
7+
#
8+
# 1. Using pipenv run
9+
# pipenv run ./dev/test_scripts_help.sh
10+
#
11+
# 2. Using pipenv shell
12+
# pipenv shell
13+
# ./dev/test_scripts_help.sh
14+
#
15+
# 3. A properly configured environment
16+
# (see .github/workflows/test_scripts_help.yml)
717
#
818
#### SETUP ####################################################################
919

@@ -42,4 +52,5 @@ test_help() {
4252

4353
cd "${DIR_REPO}"
4454
test_help
55+
echo "exit status: ${EXIT_STATUS}"
4556
exit ${EXIT_STATUS}

0 commit comments

Comments
 (0)