Skip to content

Commit 3359407

Browse files
authored
Add some comments to external APIs (#2272)
## Summary: Jeremy asked me to add some comments Author: handeyeco Reviewers: jeremywiebe Required Reviewers: Approved By: jeremywiebe Checks: ✅ 8 checks were successful Pull Request URL: #2272
1 parent 1b5f514 commit 3359407

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

.changeset/strange-yaks-train.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@khanacademy/perseus-core": patch
3+
"@khanacademy/perseus-score": patch
4+
---
5+
6+
Add comments to external-facing functions

packages/perseus-core/src/utils/split-perseus-item.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ import {getUpgradedWidgetOptions} from "../widgets/upgrade";
66
import type {PerseusRenderer} from "../data-schema";
77

88
/**
9-
* Upgrades widget options and removes answerful data for all the widgets in a
10-
* Perseus item.
9+
* Return a copy of a Perseus item with rubric data removed (ie answers)
10+
*
11+
* @param originalItem - the original, full Perseus item (which includes the rubric - aka answer data)
1112
*/
1213
export default function splitPerseusItem(
1314
originalItem: PerseusRenderer,

packages/perseus-score/src/score.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,13 @@ export function flattenScores(widgetScoreMap: {
122122
return Object.values(widgetScoreMap).reduce(combineScores, noScore);
123123
}
124124

125-
// once scorePerseusItem is the only one calling scoreWidgetsFunctional
125+
/**
126+
* score a Perseus item
127+
*
128+
* @param perseusRenderData - the full answer data, includes the correct answer
129+
* @param userInputMap - the user's input for each widget, mapped by ID
130+
* @param locale - string locale for math parsing ("de" 1.000,00 vs "en" 1,000.00)
131+
*/
126132
export function scorePerseusItem(
127133
perseusRenderData: PerseusRenderer,
128134
userInputMap: UserInputMap,

0 commit comments

Comments
 (0)