From b820794790eb514a2ef6bb0e69dc893917ea9894 Mon Sep 17 00:00:00 2001
From: William Welling <wwelling@library.tamu.edu>
Date: Tue, 14 Dec 2021 18:11:37 -0600
Subject: [PATCH] comment env-to-yaml script

---
 scripts/env-to-yaml.ts | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/scripts/env-to-yaml.ts b/scripts/env-to-yaml.ts
index 47f876f20a..edcdfd90b4 100644
--- a/scripts/env-to-yaml.ts
+++ b/scripts/env-to-yaml.ts
@@ -2,8 +2,15 @@ import * as fs from 'fs';
 import * as yaml from 'js-yaml';
 import { join } from 'path';
 
-const args = process.argv.slice(2);
+/**
+ * Script to help convert previous version environment.*.ts to yaml.
+ *
+ * Usage (see package.json):
+ * 
+ * yarn env:yaml [relative path to environment.ts file] (optional relative path to write yaml file) *
+ */
 
+const args = process.argv.slice(2);
 if (args[0] === undefined) {
   console.log(`Usage:\n\tyarn env:yaml [relative path to environment.ts file] (optional relative path to write yaml file)\n`);
   process.exit(0);