Skip to content

Commit 0bcfb76

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

1 file changed

Lines changed: 6 additions & 10 deletions

File tree

src/prepareCommitMsg.ts

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,7 @@ export function _combineOldAndNew(
259259
*
260260
* @param lines An array of values describing file change from Git output.
261261
* e.g. ["A baz.txt"]
262-
* @param oldMsg The commit message that was in UI box before running the
263-
* extension's command.
262+
* @param oldMsg Existing commit message.
264263
*/
265264
export function _generateMsgWithOld(lines: string[], oldMsg: string) {
266265
if (oldMsg === "") {
@@ -276,17 +275,14 @@ export function _generateMsgWithOld(lines: string[], oldMsg: string) {
276275
/**
277276
* Generate commit message.
278277
*
279-
* This is a public wrapper function to allow an existing message to be set or
280-
* not.
281-
*
282-
* Old message could be the current commit message value in the UI box (which
283-
* might be a commit message template that VS Code has filled in), or a commit
284-
* message template read from a file in the case of a hook flow without VS Code.
278+
* A public wrapper function to allow an existing message to be set.
285279
*
286280
* @param lines An array of values describing file change from Git output.
287281
* e.g. ["A baz.txt"]
288-
* @param oldMsg The commit message that was in UI box before running the
289-
* extension's command.
282+
* @param oldMsg Existing commit message.This could be the current commit
283+
* message value in the UI box (which might be a commit message template that
284+
* VS Code has filled in), or a commit message template read from a file in
285+
* the case of a hook flow without VS Code.
290286
*/
291287
export function generateMsg(lines: string[], oldMsg?: string): string {
292288
if (!oldMsg) {

0 commit comments

Comments
 (0)