diff --git a/packages/perseus/src/validation.types.ts b/packages/perseus/src/validation.types.ts index 57b3e3a78e..82f5b58062 100644 --- a/packages/perseus/src/validation.types.ts +++ b/packages/perseus/src/validation.types.ts @@ -9,10 +9,10 @@ * entered. This is referred to as the 'guess' in some older parts of Perseus. * * `PerseusValidationData`: the data needed to do validation of the - * user input. Validation is the checks we can do both on the client-side, - * before submitting user input for scoring, and on the server-side when we - * score it. As such, it cannot contain any of the sensitive scoring data - * that would reveal the answer. + * user input. Validation refers to the different checks that we can do both on + * the client-side (before submitting user input for scoring) and on the + * server-side (when we score it). As such, it cannot contain any of the + * sensitive scoring data that would reveal the answer. * * `PerseusScoringData` (nee `PerseusRubric`): the data needed * to score the user input. By convention, this type is defined as the set of @@ -22,7 +22,8 @@ * For example: * ``` * type PerseusScoringData = { - * correct: string; + * correct: string; // Used _only_ for scoring + * size: number; // Used _only_ for scoring * } & PerseusValidationData; * ``` */