docs: update cli.ts

MichaelCurrin · MichaelCurrin · commit 721c4ed85300 · 2021-09-01T11:22:46.000+02:00
diff --git a/src/cli.ts b/src/cli.ts
@@ -1,12 +1,13 @@
 /**
  * CLI module.
  *
- * This is the entry-point for the Auto Commit Message tool when running as an STANDALONE
- * command-line script.
+ * This is the entry-point for the Auto Commit Message tool when running as a STANDALONE
+ * command-line script i.e. without VS Code.
  *
- * This script does NOT interact with VS Code or any Git commands. It just receives text as an
- * argument and prints output to `stdout` for use in a hook flow. Or `stderr` in the case of a
- * message not appropriate for a commit message.
+ * This script does NOT interact with VS Code or the Git.
+ *
+ * It simply receives text as an argument and prints output to `stdout` for use in a hook flow. Or
+ * `stderr`, in the case of a message not appropriate for a commit message.
  *
  * See `shell/README.md` docs.
  */

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,13 @@`
`1`	`1`	`/**`
`2`	`2`	`* CLI module.`
`3`	`3`	`*`
`4`		`- * This is the entry-point for the Auto Commit Message tool when running as an STANDALONE`
`5`		`- * command-line script.`
	`4`	`+ * This is the entry-point for the Auto Commit Message tool when running as a STANDALONE`
	`5`	`+ * command-line script i.e. without VS Code.`
`6`	`6`	`*`
`7`		`- * This script does NOT interact with VS Code or any Git commands. It just receives text as an`
`8`		- * argument and prints output to `stdout` for use in a hook flow. Or `stderr` in the case of a
`9`		`- * message not appropriate for a commit message.`
	`7`	`+ * This script does NOT interact with VS Code or the Git.`
	`8`	`+ *`
	`9`	+ * It simply receives text as an argument and prints output to `stdout` for use in a hook flow. Or
	`10`	+ * `stderr`, in the case of a message not appropriate for a commit message.
`10`	`11`	`*`
`11`	`12`	* See `shell/README.md` docs.
`12`	`13`	`*/`