docs, tidy

UKForeignOffice · Aug 23, 2023 · d2024ce · d2024ce
1 parent 47582a1
commit d2024ce
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/src/scheduler/workers/processListsBeforeAndDuringStart/helpers.ts b/src/scheduler/workers/processListsBeforeAndDuringStart/helpers.ts
@@ -37,6 +37,10 @@ export function isEmailSentBefore(event: Audit | undefined, reminderType: Remind
   return false;
 }
 
+/**
+ * Determines whether `emailType` should be sent for `annualReviewReference`.
+ * All annual review audits or events are recorded with the {@link annualReviewReference} or `reference` from `{@link List.jsonData.currentAnnualReview.reference}`.
+ */
 export async function shouldSend(
   emailType: AnnualReviewProviderEmailType,
   listItemId: number,

diff --git a/...server/models/db/migrations/20230725094906_add_email_type_columns_to_tables/migration.sql b/...server/models/db/migrations/20230725094906_add_email_type_columns_to_tables/migration.sql
@@ -41,7 +41,7 @@ select  cast("jsonData"->>'itemId' as int) "itemId",
         jsonb_build_object(
           'itemId', "jsonData"->'itemId',
           'reference', "jsonData"->'annualReviewRef',
-          'annualReviewRef', "jsonData"->'annualReviewRef'
+          'annualReviewRef', "jsonData"->'annualReviewRef',
           'eventName', "jsonData"->'eventName',
           'reminderType', "jsonData"->'reminderType',
           ),