Skip to content

Commit c29ef86

Browse files
committed
docs: update gitExtension.ts
1 parent 6c69a50 commit c29ef86

1 file changed

Lines changed: 2 additions & 7 deletions

File tree

src/gitExtension.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,21 @@
66
* This module takes care of the high-level flow of the extension, after a repo
77
* is selected in extension.ts module.
88
*
9-
* This module handles reading git output, processes it with the logic in the
9+
* This module handles reading Git output, processes it with the logic in the
1010
* generate module and then finally sets it in the UI message box.
1111
*/
1212
import * as vscode from "vscode";
1313
import { GitExtension, Repository } from "./api/git";
1414

1515
/**
1616
* Fetch the commit message in the Git Extension.
17-
*
18-
* This could useful when doing conventional commits, as the initial 'feat' or
19-
* 'feat: ' portion or similar can be kept as a prefix while the generated
20-
* message added on. Or if left out, it can be generated if possible such as for
21-
* 'chore' or 'docs'.
2217
*/
2318
export function getCommitMsg(repository: Repository): string {
2419
return repository.inputBox.value;
2520
}
2621

2722
/**
28-
* Set the commit message in the Git Extension.
23+
* Set the commit message in the Git Extension pane's input.
2924
*/
3025
export function setCommitMsg(repository: Repository, msg: string) {
3126
repository.inputBox.value = msg;

0 commit comments

Comments
 (0)