File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -51,6 +51,8 @@ export function _prefixFromChange(line: string) {
5151
5252/**
5353 * Generate message for a single file change.
54+ *
55+ * @param line Description of a file change from Git output. e.g. "A baz.txt"
5456 */
5557export function _msgOne ( line : string ) {
5658 // TODO: Pass FileChanges to oneChange and _prefixFromChange instead of string.
@@ -63,9 +65,11 @@ export function _msgOne(line: string) {
6365}
6466
6567/**
66- * Get single Conventional Commit type prefix from multiple items.
68+ * Determine a single type prefix from multiple values given.
69+ *
70+ * @param types An array of Convention Commit type prefixes.
6771 *
68- * @returns Inferred overall prefix type.
72+ * @returns A single prefix type.
6973 * - Unknown if zero items - not likely in real life but covered anyway.
7074 * - The first item if they are equal.
7175 * - Use unknown if they are different.
You can’t perform that action at this time.
0 commit comments