From 2eee668ee7840f7e7063fa0eae918e808f3ccef8 Mon Sep 17 00:00:00 2001
From: Wlowscha <54003515+Wlowscha@users.noreply.github.com>
Date: Sun, 2 Mar 2025 01:38:34 +0100
Subject: [PATCH] Added docstring to checkValidForChallenge

---
 src/ui/starter-select-ui-handler.ts | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/ui/starter-select-ui-handler.ts b/src/ui/starter-select-ui-handler.ts
index 3107a2c1ffc..315e84d8fc6 100644
--- a/src/ui/starter-select-ui-handler.ts
+++ b/src/ui/starter-select-ui-handler.ts
@@ -1300,6 +1300,13 @@ export default class StarterSelectUiHandler extends MessageUiHandler {
     });
   }
 
+  /**
+   * Apply all challenges to the given species (and form) to check its validity.
+   * @param species {@link PokemonSpecies} The species to check the validity of.
+   * @param dexAttr {@link DexAttrProps} The dex attributes of the species, including its form index.
+   * @param soft {@link boolean} If true, allow it if it could become valid through evolution or form change.
+   * @returns True if the species is considered valid.
+   */
   checkValidForChallenge(species: PokemonSpecies, props: DexAttrProps, soft: boolean) {
     if (!soft) {
       const isValidForChallenge = new BooleanHolder(true);