refactor: add comment

ti-community-infra · Sep 28, 2020 · 1577373 · 1577373
1 parent 26c7ee0
commit 1577373
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/src/services/pull/index.ts b/src/services/pull/index.ts
@@ -18,7 +18,7 @@ import { ContributorSchema, SigInfoSchema } from "../../config/SigInfoSchema";
 import { Sig } from "../../db/entities/Sig";
 import { SigMember, SigMemberLevel } from "../../db/entities/SigMember";
 import {
-  collectContributorsByLevel,
+  collectContributorsWithLevel,
   ContributorInfoWithLevel,
 } from "../utils/SigInfoUtils";
 import { ContributorInfo } from "../../db/entities/ContributorInfo";
@@ -298,7 +298,7 @@ export default class PullService {
 
     // Get the PR's members diff.
     const oldMembersWithLevel = await this.listSigMembers(sig.id);
-    const newMembersWithLevel = collectContributorsByLevel(sigInfo);
+    const newMembersWithLevel = collectContributorsWithLevel(sigInfo);
     const difference = [...newMembersWithLevel].filter((nm) =>
       [...oldMembersWithLevel].every((om) => !equal(om, nm))
     );

diff --git a/src/services/sig/index.ts b/src/services/sig/index.ts
@@ -11,7 +11,7 @@ import { Reply, Status } from "../reply";
 import { FileStatus } from "../pull";
 import { ContributorSchema, SigInfoSchema } from "../../config/SigInfoSchema";
 import { SigMessage } from "../messages/SigMessage";
-import { collectContributorsByLevel } from "../utils/SigInfoUtils";
+import { collectContributorsWithLevel } from "../utils/SigInfoUtils";
 
 const axios = require("axios").default;
 
@@ -95,7 +95,7 @@ export class SigService {
     for (let i = 0; i < files.length; i++) {
       const { data: sigInfo } = await axios.get(files[i].raw_url);
       const sig = await this.findOrAddSig(sigInfo);
-      const contributorInfos = collectContributorsByLevel(sigInfo);
+      const contributorInfos = collectContributorsWithLevel(sigInfo);
 
       const contributorInfosMap = new Map(
         contributorInfos.map((c) => [c.githubId, c])

diff --git a/src/services/utils/SigInfoUtils.ts b/src/services/utils/SigInfoUtils.ts
@@ -9,7 +9,11 @@ export interface ContributorInfoWithLevel {
   company?: string;
 }
 
-export function collectContributorsByLevel(
+/**
+ * Collect contributor info with level.
+ * @param sigInfo Sig info.
+ */
+export function collectContributorsWithLevel(
   sigInfo: SigInfoSchema
 ): ContributorInfoWithLevel[] {
   const contributorInfos: ContributorInfoWithLevel[] = [];