From d0281e64bf02cf4bd4f21f73ba654157e44a3a21 Mon Sep 17 00:00:00 2001
From: thepaperpilot <thepaperpilot@gmail.com>
Date: Wed, 5 Apr 2023 07:43:48 -0500
Subject: [PATCH] Documented modifierToFormula

---
 src/data/common.tsx | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/data/common.tsx b/src/data/common.tsx
index d163f72..3246135 100644
--- a/src/data/common.tsx
+++ b/src/data/common.tsx
@@ -492,6 +492,11 @@ export function createFormulaPreview(
     });
 }
 
+/**
+ * Utility for converting a modifier into a formula. Takes the input for this formula as the base parameter.
+ * @param modifier The modifier to convert to the formula
+ * @param base An existing formula or processed DecimalSource that will be the input to the formula
+ */
 export function modifierToFormula<T extends GenericFormula>(
     modifier: WithRequired<Modifier, "revert">,
     base: T