From 9062ad4b7a6503da12913d59a1cc76c9d70a1c85 Mon Sep 17 00:00:00 2001
From: ahmedmgamal94 <98055904+ahmedmgamal94@users.noreply.github.com>
Date: Thu, 19 Sep 2024 13:25:42 -0700
Subject: [PATCH] generate permutation comment

---
 src/features/armor-optimization/generate-permutations.ts | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/features/armor-optimization/generate-permutations.ts b/src/features/armor-optimization/generate-permutations.ts
index 497d8f0..59e7998 100644
--- a/src/features/armor-optimization/generate-permutations.ts
+++ b/src/features/armor-optimization/generate-permutations.ts
@@ -7,7 +7,11 @@ import {
   ExoticClassCombo,
   FragmentStatModifications,
 } from '../../types/d2l-types';
-
+/**
+ * This function generates all possible permutations of armor based on class, selected exotic item (if any), 
+ * and fragment modifications. It tracks and stores the top 30,000 permutations in a max heap based on the total stats. 
+ * The function returns a sorted array of permutations of type DestinyArmor[].
+ */
 export function generatePermutations(
   armorClass: ArmorBySlot,
   selectedExoticItem: { itemHash: number | null; slot: armor | null } = {