Skip to content

Commit d56d672

Browse files
committed
update cli.ts
1 parent 174eda2 commit d56d672

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

src/cli.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
* CLI module.
33
*
44
* This is the entry-point for the Auto Commit Message tool when running as a
5-
* STANDALONE command-line script i.e. without VS Code.
5+
* standalone shell script.
66
*
7-
* This script does NOT interact with VS Code or the Git.
7+
* This script does NOT interact with VS Code or Git, it only processes text.
88
*
99
* It simply receives text as an argument and prints output to `stdout` for use
10-
* in a hook flow. Or `stderr`, in the case of a message not appropriate for a
11-
* commit message.
10+
* in a hook flow. Or to `stderr`, in the case of a message not appropriate for
11+
* a commit message.
1212
*
1313
* See `shell/README.md` in docs.
1414
*/
@@ -17,7 +17,8 @@ import { generateMsg } from "./prepareCommitMsg";
1717
/**
1818
* Command-line entry-point.
1919
*
20-
* Expect multi-line text from `git diff-index` command as the first item in the shell arguments.
20+
* Expect multi-line text from `git diff-index` command as the first item in the
21+
* shell arguments.
2122
*
2223
* Returns a suitable generated commit message as text.
2324
*/

0 commit comments

Comments
 (0)