From 06bc8c40c0335cd8abc1751bb5416402d9fee414 Mon Sep 17 00:00:00 2001 From: iAmWillShepherd Date: Thu, 2 Nov 2017 13:46:01 -0500 Subject: [PATCH] Add some comments --- app/src/lib/stores/pull-request-store.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/app/src/lib/stores/pull-request-store.ts b/app/src/lib/stores/pull-request-store.ts index f27ad6c5403..63fcf91e167 100644 --- a/app/src/lib/stores/pull-request-store.ts +++ b/app/src/lib/stores/pull-request-store.ts @@ -32,7 +32,7 @@ export class PullRequestStore { this.repositoriesStore = repositoriesStore } - /** Update the list of open pull requests for the repository. */ + /** Loads all pull requests against the given repository. */ public async refreshPullRequests( repository: GitHubRepository, account: Account @@ -64,6 +64,7 @@ export class PullRequestStore { } } + /** Loads the status for a given pull request. */ public async refreshSinglePullRequestStatus( repository: GitHubRepository, account: Account, @@ -72,6 +73,7 @@ export class PullRequestStore { await this.refreshStatusesForPRs([pullRequest], repository, account) } + /** Loads the status for all pull request against a given repository. */ public async refreshPullRequestStatuses( repository: GitHubRepository, account: Account @@ -82,6 +84,7 @@ export class PullRequestStore { } public async refreshStatusesForPRs( + /** Get the pull requests from the database. */ pullRequests: ReadonlyArray, repository: GitHubRepository, account: Account