add suggested docblock for buffSoonPresent

Krealle · Mar 28, 2024 · 9d01fa2 · 9d01fa2
1 parent 2fe5fbd
commit 9d01fa2
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/parser/shared/metrics/apl/conditions/buffSoonPresent.tsx b/src/parser/shared/metrics/apl/conditions/buffSoonPresent.tsx
@@ -13,6 +13,12 @@ type BuffInformation = {
 
 type SourceOptions = 'player' | 'external' | 'any';
 
+/**
+ * Check if a buff will be present soon after the present time.
+ *
+ * This should ONLY be used for buffs that the player has complete control over, such as buffs tied to cooldown use.
+ * DO NOT use this to "look ahead" for random procs to implement impossibly optimal APLs.
+ */
 export function buffSoonPresent(
   spell: Spell,
   range: Range,