Skip to content

Commit f3cedc5

Browse files
committed
Add documentation
1 parent a079813 commit f3cedc5

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

src/components/GitPanel.tsx

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -271,14 +271,24 @@ export class GitPanel extends React.Component<
271271
);
272272
}
273273

274-
/** Commit all marked files */
274+
/**
275+
* Commits all marked files.
276+
*
277+
* @param message - commit message
278+
* @returns a promise which commits the files
279+
*/
275280
private _commitMarkedFiles = async (message: string): Promise<void> => {
276281
await this.props.model.reset();
277282
await this.props.model.add(...this._markedFiles.map(file => file.to));
278283
await this._commitStagedFiles(message);
279284
};
280285

281-
/** Commit all staged files */
286+
/**
287+
* Commits all staged files.
288+
*
289+
* @param message - commit message
290+
* @returns a promise which commits the files
291+
*/
282292
private _commitStagedFiles = async (message: string): Promise<void> => {
283293
try {
284294
if (
@@ -294,7 +304,10 @@ export class GitPanel extends React.Component<
294304
}
295305
};
296306

297-
private get _modifiedFiles() {
307+
/**
308+
* List of modified files (both staged and unstaged).
309+
*/
310+
private get _modifiedFiles(): Git.IStatusFileResult[] {
298311
let files = this.state.untrackedFiles.concat(
299312
this.state.unstagedFiles,
300313
this.state.stagedFiles
@@ -304,7 +317,10 @@ export class GitPanel extends React.Component<
304317
return files;
305318
}
306319

307-
private get _markedFiles() {
320+
/**
321+
* List of marked files.
322+
*/
323+
private get _markedFiles(): Git.IStatusFileResult[] {
308324
return this._modifiedFiles.filter(file =>
309325
this.props.model.getMark(file.to)
310326
);

0 commit comments

Comments
 (0)