Skip to content

Commit

Permalink
Add documentation to validate function
Browse files Browse the repository at this point in the history
  • Loading branch information
Myranae committed Nov 20, 2024
1 parent 261fcf1 commit 9437cfd
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ import type {
PerseusCategorizerValidationData,
} from "../../validation.types";

/**
* Checks userInput from the categorizer widget to see if the user has selected
* a category for each item.
* @param userInput - The user's input corresponding to an array of indices that
* represent the selected category for each row/item.
* @param validationData - An array of strings corresponding to each row/item
* @param strings - Used to provide a validation message
*/
function validateCategorizer(
userInput: PerseusCategorizerUserInput,
validationData: PerseusCategorizerValidationData,
Expand Down

0 comments on commit 9437cfd

Please sign in to comment.