Merge pull request #54 from tronghieuvuong/tvuong/minorDocumentation

Fix documentation.
bcgov · Dec 15, 2023 · 10802bc · 10802bc
2 parents 423bd0e + 3ec7008
commit 10802bc
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/apps/application-status/helper/getSprints.ts b/apps/application-status/helper/getSprints.ts
@@ -3,6 +3,15 @@ import { castingReleases, castingSprint } from './castingResponse'
 import { filterReleasesByDate, filterReleaseByTeam } from './filterRelease'
 import { TeamSprints } from '~/interface/interfaces'
 
+/**
+ * Get all of the sprints in each Zenhub board.
+ * @param boardId
+ * @param startCursor
+ * @param endCursor
+ * @param releases
+ * @param team
+ * @returns
+ */
 export default async function getSprints (boardId: string, startCursor: string, endCursor: string, releases: any, team: string) {
   const data = await getAllSprints(boardId, startCursor, endCursor)
   const result: TeamSprints = {