[WIP]: add --job{s} option comment.

0xfe · Dec 22, 2021 · 9fe7451 · 9fe7451
1 parent 38f6d32
commit 9fe7451
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/tools/generate_images_pptr.js b/tools/generate_images_pptr.js
@@ -18,6 +18,9 @@ const jobLog = (msg, type, jobInfo) => {
   log(`${prefix}${msg}`, type);
 };
 
+/**
+ * --job{s} see tests/vexflow_test_helpers.ts: VexFlowTests.run()
+ */
 const usage = () => {
   if (!options.IMAGE_OUTPUT_DIR) {
     log(

diff --git a/tools/generate_png_images.js b/tools/generate_png_images.js
@@ -24,6 +24,11 @@ const runOptions = {
 // For example:
 //   node generate_png_images.js SCRIPT_DIR IMAGE_OUTPUT_DIR --fonts=petaluma
 //   node generate_png_images.js SCRIPT_DIR IMAGE_OUTPUT_DIR --fonts=bravura,gonville
+/**
+ * usage: node generate_png_images.js SCRIPT_DIR IMAGE_OUTPUT_DIR [--fonts=fonts] [--jobs=jobs] [--job=job]
+ *   --jobs, --job: see tests/vexflow_test_helpers.ts: VexFlowTests.run()
+ */
+
 const ALL_FONTS = ['Bravura', 'Gonville', 'Petaluma'];
 let fontStacksToTest = ALL_FONTS;
 const { argv } = process;