improve shellcheck comments

1988/dale/try.sh

@@ -22,7 +22,10 @@ echo 1>&2
 
 read -r -n 1 -p "Press any key to run: ./dale these files are in this directory: *: "
 echo 1>&2
+# We need * and do not care about dashes
+#
 # SC2035 (info): Use ./*glob* or -- *glob* so names with dashes won't become options.
+# https://www.shellcheck.net/wiki/SC2035
 # shellcheck disable=SC2035
 ./dale these files are in this directory: *
 echo 1>&2
@@ -32,29 +35,28 @@ echo "Why do they differ in the format from the above command? Finally how can y
 echo "get the more likely desired behaviour?" 1>&2
 echo 1>&2
 echo 1>&2
-# This warning from ShellCheck is incorrect:
-#
-#   SC2028 (info): echo may not expand escape sequences. Use printf.
-#
-# because we deliberately have \\n to show that there will be a newline printed
-# WITH printf(1). Thus this does show correct output.
+# This warning from ShellCheck is incorrect because we deliberately have \\n to show that
+# there will be a newline printed WITH printf(1). Thus this does show correct output.
 #
+# SC2028 (info): echo may not expand escape sequences. Use printf.
+# https://www.shellcheck.net/wiki/SC2028
 # shellcheck disable=SC2028
 echo "$ ./dale \$(printf "the following files exist in this directory:\\n%s\\n" *)"
 read -r -n 1 -p "Press any key to continue: "
 echo 1>&2
+# We do not care about word splitting in this case.
+#
 # SC2046 (warning): Quote this to prevent word splitting.
+# https://www.shellcheck.net/wiki/SC2046
 # shellcheck disable=SC2046
 ./dale $(printf "the following files exist in this directory:\n%s\n" *)
 echo 1>&2
 
-# This warning from ShellCheck is incorrect:
-#
-#   SC2028 (info): echo may not expand escape sequences. Use printf.
-#
-# because we deliberately have \\n to show that there will be a newline printed
-# WITH printf(1). Thus this does show correct output.
+# This warning from ShellCheck is incorrect because we deliberately have \\n to show that
+# there will be a newline printed WITH printf(1). Thus this does show correct output.
 #
+#SC2028 (info): echo may not expand escape sequences. Use printf.
+# https://www.shellcheck.net/wiki/SC2028
 # shellcheck disable=SC2028
 echo "$ ./dale \"\$(printf \"the following files exist in this directory:\\n%s\\n\" *)\""
 read -r -n 1 -p "Press any key to continue: "