doc strings

ptpaterson · echo-bravo-yahoo · commit 191c1e8958db · 2024-12-05T13:17:24.000-08:00
diff --git a/src/lib/config/config.mjs b/src/lib/config/config.mjs
@@ -91,7 +91,8 @@ function validateConfig(profileName, profileBody, configPath) {
 }
 
 /**
- * Creates a yargs parser given existing command line arguments
+ * A parser to convert config files into appropriate command line arguments
+ * given existing arguments.
  *
  * @param {string|string[]} argvInput - The raw command line arguments.
  * @param {string} path

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,8 @@ function validateConfig(profileName, profileBody, configPath) {`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`/**`
`94`		`- * Creates a yargs parser given existing command line arguments`
	`94`	`+ * A parser to convert config files into appropriate command line arguments`
	`95`	`+ * given existing arguments.`
`95`	`96`	`*`
`96`	`97`	`* @param {string\|string[]} argvInput - The raw command line arguments.`
`97`	`98`	`* @param {string} path`