Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Signed-off-by: Simon Behar <[email protected]>
  • Loading branch information
simster7 committed Feb 12, 2021
1 parent 9bdbca4 commit d828a78
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions hack/check-env-doc.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

echo "Checking env variables doc for completness..."
echo "Checking docs/environment-variables.md for completeness..."

function check-used {
grep "| \`" < ./docs/environment-variables.md \
Expand All @@ -9,7 +9,7 @@ function check-used {
var="${x%\`}";
var="${var#\`}";
if ! grep -qR --exclude="*_test.go" "$var" ./workflow ./persist ./util; then
echo "Documented variable $var is not used anywhere";
echo "Documented variable $var in docs/environment-variables.md is not used anywhere";
exit 1;
fi;
done
Expand All @@ -24,7 +24,7 @@ function check-documented {
var="${x%\"}";
var="${var#\"}";
if ! grep -q "$var" docs/environment-variables.md; then
echo "Variable $var not documented in docs/environment-variables";
echo "Variable $var not documented in docs/environment-variables.md";
exit 1;
fi;
done
Expand Down

0 comments on commit d828a78

Please sign in to comment.