Add some comments to external APIs #2272
Merged
+16
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
handeyeco
changed the title
|
Size Change: +121 B (+0.02%) Total Size: 736 kB
ℹ️ View Unchanged
|
npm Snapshot: PublishedGood news!! We've packaged up the latest commit from this PR (53fbed2) and published it to npm. You Example: pnpm add @khanacademy/perseus@PR2272If you are working in Khan Academy's webapp, you can run: ./dev/tools/bump_perseus_version.sh -t PR2272 |
handeyeco
added
🐍 project: sss
jeremywiebe
approved these changes
Mar 18, 2025
| @@ -5,6 +5,11 @@ import {getUpgradedWidgetOptions} from "../widgets/upgrade"; | |||
|
|
|||
| import type {PerseusRenderer} from "../data-schema"; | |||
|
|
|||
| /** | |||
| * get a copy of a Perseus item with pre-scoring data removed (ie answers) | |||
There was a problem hiding this comment.
I think we agreed to call this rubric data.
Suggested change
| * get a copy of a Perseus item with pre-scoring data removed (ie answers) | |
| * Return a copy of a Perseus item with rubric data removed (ie answers) |
| /** | ||
| * get a copy of a Perseus item with pre-scoring data removed (ie answers) | ||
| * | ||
| * @param originalItem - the full answer data, includes the correct answer |
There was a problem hiding this comment.
Suggested change
| * @param originalItem - the full answer data, includes the correct answer | |
| * @param originalItem - the original, full Perseus item (which includes the rubric - aka answer data) |
Merged
handeyeco
pushed a commit
that referenced
this pull request
Mar 25, 2025
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @khanacademy/keypad-context@1.1.6 ### Patch Changes - Updated dependencies \[[`1b5f51415`](1b5f514), [`4c0b317c3`](4c0b317), [`335940746`](3359407)]: - @khanacademy/perseus-core@5.4.1 ## @khanacademy/kmath@0.4.6 ### Patch Changes - Updated dependencies \[[`1b5f51415`](1b5f514), [`4c0b317c3`](4c0b317), [`335940746`](3359407)]: - @khanacademy/perseus-core@5.4.1 ## @khanacademy/math-input@23.0.5 ### Patch Changes - Updated dependencies \[[`1b5f51415`](1b5f514), [`4c0b317c3`](4c0b317), [`335940746`](3359407)]: - @khanacademy/perseus-core@5.4.1 - @khanacademy/keypad-context@1.1.6 ## @khanacademy/perseus@57.2.1 ### Patch Changes - [#2289](#2289) [`87420d7d3`](87420d7) Thanks [@handeyeco](https://github.com/handeyeco)! - Update ServerItemRendererWithDebugUI to optionally use answerless data for rendering - [#2313](#2313) [`3b0b1c700`](3b0b1c7) Thanks [@nishasy](https://github.com/nishasy)! - [LX] Stop locked functions from memory leaking - Updated dependencies \[[`1b5f51415`](1b5f514), [`c170c1d3c`](c170c1d), [`4c0b317c3`](4c0b317), [`335940746`](3359407)]: - @khanacademy/perseus-core@5.4.1 - @khanacademy/perseus-score@2.3.6 - @khanacademy/keypad-context@1.1.6 - @khanacademy/kmath@0.4.6 - @khanacademy/math-input@23.0.5 - @khanacademy/perseus-linter@1.3.6 ## @khanacademy/perseus-core@5.4.1 ### Patch Changes - [#2308](#2308) [`1b5f51415`](1b5f514) Thanks [@benchristel](https://github.com/benchristel)! - Fix a bug in numeric input scoring where `simplify` value of `false` led to incorrect scoring logic being applied - [#2319](#2319) [`4c0b317c3`](4c0b317) Thanks [@benchristel](https://github.com/benchristel)! - Internal: unskip regression tests for Perseus JSON parser and update snapshots - [#2272](#2272) [`335940746`](3359407) Thanks [@handeyeco](https://github.com/handeyeco)! - Add comments to external-facing functions ## @khanacademy/perseus-editor@18.2.1 ### Patch Changes - Updated dependencies \[[`1b5f51415`](1b5f514), [`c170c1d3c`](c170c1d), [`87420d7d3`](87420d7), [`4c0b317c3`](4c0b317), [`335940746`](3359407), [`3b0b1c700`](3b0b1c7)]: - @khanacademy/perseus-core@5.4.1 - @khanacademy/perseus-score@2.3.6 - @khanacademy/perseus@57.2.1 - @khanacademy/keypad-context@1.1.6 - @khanacademy/kmath@0.4.6 - @khanacademy/math-input@23.0.5 - @khanacademy/perseus-linter@1.3.6 ## @khanacademy/perseus-linter@1.3.6 ### Patch Changes - Updated dependencies \[[`1b5f51415`](1b5f514), [`4c0b317c3`](4c0b317), [`335940746`](3359407)]: - @khanacademy/perseus-core@5.4.1 ## @khanacademy/perseus-score@2.3.6 ### Patch Changes - [#2278](#2278) [`c170c1d3c`](c170c1d) Thanks [@handeyeco](https://github.com/handeyeco)! - Remove jQuery as a dependency of perseus-score - [#2272](#2272) [`335940746`](3359407) Thanks [@handeyeco](https://github.com/handeyeco)! - Add comments to external-facing functions - Updated dependencies \[[`1b5f51415`](1b5f514), [`4c0b317c3`](4c0b317), [`335940746`](3359407)]: - @khanacademy/perseus-core@5.4.1 - @khanacademy/kmath@0.4.6 ## @khanacademy/perseus-dev-ui@5.3.6 ### Patch Changes - Updated dependencies \[[`1b5f51415`](1b5f514), [`4c0b317c3`](4c0b317), [`335940746`](3359407)]: - @khanacademy/perseus-core@5.4.1 - @khanacademy/kmath@0.4.6 - @khanacademy/math-input@23.0.5 - @khanacademy/perseus-linter@1.3.6 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Jeremy asked me to add some comments