update check inline examples comment (#479)

faucetsdn · Oct 13, 2022 · 8c44f03 · 8c44f03
1 parent b53681d
commit 8c44f03
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/bin/gencode b/bin/gencode
@@ -11,7 +11,8 @@ if [[ $1 == check ]]; then
 fi
 
 if [[ -n $check ]]; then
-    # This check must be run before gencode_docs is run
+    # This check must be run before gencode_docs is run, because that will update
+    # the file in-place, and the checks are against the current file on disk
     bin/gencode_docs_examples check
 fi