📚 Docs: Add missing JSDoc/TSDoc to components and utilities#752
Merged
📚 Docs: Add missing JSDoc/TSDoc to components and utilities#752
Conversation
- Added `@param` and `@returns` tags to `CopyButton.tsx` and `ExerciseWidget.tsx`. - Documented `MarkdownRenderer` and its parser function. - Added JSDoc for `Sidebar` component. - Provided standard TSDoc block for `prism.ts`. - Documented `curriculumConfig.ts` constants with appropriate type tags. - Verified all documentation and tested via pre-commit linting checks. - Appended progress to `.jules/docs-progress.md`. Co-authored-by: saint2706 <45678566+saint2706@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
📚 Docs: Add missing JSDoc/TSDoc to components and utilities
@paramand@returnstags toCopyButton.tsxandExerciseWidget.tsx.MarkdownRendererand its parser function.Sidebarcomponent.prism.ts.curriculumConfig.tsconstants with appropriate type tags..jules/docs-progress.md.PR created automatically by Jules for task 18018517301721701797 started by @saint2706