Add some comments

ITCSBarbie · Nov 2, 2017 · 06bc8c4 · 06bc8c4
1 parent 460d0c6
commit 06bc8c4
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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<PullRequest>,
     repository: GitHubRepository,
     account: Account