From 4f893e07691e4cfe8c588ea85ec2c8689f87bdda Mon Sep 17 00:00:00 2001
From: rr-bw <102181210+rr-bw@users.noreply.github.com>
Date: Sat, 7 Sep 2024 13:03:15 -0700
Subject: [PATCH] minor updates to comments for clarity

---
 libs/auth/src/angular/login/login.component.html | 8 +++++++-
 libs/auth/src/angular/login/login.component.ts   | 7 +++----
 2 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/libs/auth/src/angular/login/login.component.html b/libs/auth/src/angular/login/login.component.html
index d6b22e91c4..bf8f7d9dcf 100644
--- a/libs/auth/src/angular/login/login.component.html
+++ b/libs/auth/src/angular/login/login.component.html
@@ -32,7 +32,7 @@
       </button>
     </div>
 
-    <!-- Login with Passkey link -->
+    <!-- Link to Login with Passkey page -->
     <div class="tw-mb-3 tw-flex tw-flex-col tw-items-center tw-justify-center">
       <p class="tw-mb-3">{{ "or" | i18n }}</p>
       <a
@@ -48,6 +48,7 @@
 
     <hr />
 
+    <!-- Link to Create Account page -->
     <p class="tw-m-0 tw-text-sm">
       {{ "newAroundHere" | i18n }}
       <!-- Two notes:  
@@ -71,11 +72,14 @@
   ------------------------------------>
   <ng-container *ngIf="validatedEmail">
     <div class="tw-mb-6 tw-h-28">
+      <!-- Master Password input -->
       <bit-form-field class="!tw-mb-1">
         <bit-label>{{ "masterPass" | i18n }}</bit-label>
         <input type="password" bitInput #masterPasswordInput formControlName="masterPassword" />
         <button type="button" bitSuffix bitIconButton bitPasswordInputToggle></button>
       </bit-form-field>
+
+      <!-- Link to Password Hint page -->
       <a
         class="tw-mt-2"
         routerLink="/hint"
@@ -85,10 +89,12 @@
       >
     </div>
 
+    <!-- Captcha iframe -->
     <div [hidden]="!showCaptcha()">
       <iframe id="hcaptcha_iframe" height="80" sandbox="allow-scripts allow-same-origin"></iframe>
     </div>
 
+    <!-- Button to Login with Master Password -->
     <div class="tw-mb-3 tw-flex tw-space-x-4">
       <button bitButton buttonType="primary" bitFormButton type="submit" [block]="true">
         <span> {{ "loginWithMasterPassword" | i18n }} </span>
diff --git a/libs/auth/src/angular/login/login.component.ts b/libs/auth/src/angular/login/login.component.ts
index bd6c79170d..34f0286b33 100644
--- a/libs/auth/src/angular/login/login.component.ts
+++ b/libs/auth/src/angular/login/login.component.ts
@@ -364,7 +364,7 @@ export class LoginComponentV2 implements OnInit, OnDestroy {
 
   private async webOnInit(): Promise<void> {
     this.activatedRoute.queryParams.pipe(first(), takeUntil(this.destroy$)).subscribe((qParams) => {
-      // If there is an query parameter called 'org', set previousUrl to `/create-organization?org=paramValue`
+      // If there is a parameter called 'org', set previousUrl to `/create-organization?org=<paramValue>`
       if (qParams.org != null) {
         const route = this.router.createUrlTree(["create-organization"], {
           queryParams: { plan: qParams.org },
@@ -373,9 +373,8 @@ export class LoginComponentV2 implements OnInit, OnDestroy {
       }
 
       /**
-       * If there is a query parameter called 'sponsorshipToken', that means they are coming
-       * from an email for sponsoring a families organization. If so, then set the prevousUrl
-       * to `/setup/families-for-enterprise?token=paramValue`
+       * If there is a parameter called 'sponsorshipToken', they are coming from an email for sponsoring a families organization.
+       * Therefore set the prevousUrl to `/setup/families-for-enterprise?token=<paramValue>`
        */
       if (qParams.sponsorshipToken != null) {
         const route = this.router.createUrlTree(["setup/families-for-enterprise"], {