Skip to content

Commit edbda28

Browse files
committed
docs: update prepareCommitMsg.ts
1 parent 0bcfb76 commit edbda28

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/prepareCommitMsg.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,8 @@ export function _msgCount(lines: string[]): ConvCommitMsg {
134134
* @param lines An array of values describing file change from Git output.
135135
* e.g. ["A baz.txt"]
136136
*
137-
* @returns Conventional Commit prefix and a description of changed paths.
137+
* @returns Commit message containing a type prefix and a description of changed
138+
* paths.
138139
*/
139140
export function _msgFromChanges(lines: string[]) {
140141
let result: ConvCommitMsg;
@@ -165,7 +166,7 @@ export function _formatMsg(convCommitMsg: ConvCommitMsg) {
165166
}
166167

167168
/**
168-
* Generate a new commit message and format it as a string.\
169+
* Generate a new commit message and format it as a string.
169170
*
170171
* @param lines An array of values describing file change from Git output.
171172
* e.g. ["A baz.txt"]

0 commit comments

Comments
 (0)