Add comment to validation function

Khan · Nov 20, 2024 · 74bf0e6 · 74bf0e6
1 parent b203d48
commit 74bf0e6
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/perseus/src/widgets/orderer/validate-orderer.ts b/packages/perseus/src/widgets/orderer/validate-orderer.ts
@@ -1,6 +1,12 @@
 import type {PerseusScore} from "../../types";
 import type {PerseusOrdererUserInput} from "../../validation.types";
 
+/**
+ * Checks user inputfrom the orderer widget to see if the user has started
+ * ordering the options, making the widget scorable.
+ * @param userInput
+ * @see `scoreOrderer` for more details.
+ */
 function validateOrderer(
     userInput: PerseusOrdererUserInput,
 ): Extract<PerseusScore, {type: "invalid"}> | null {