docs: add JSDoc and TSDoc comments to src modules #298
Conversation
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=80&v=4){kind=small}
YiweiShen
approved these changes
Jun 28, 2025
YiweiShen
deleted the
codez-docs-296-add-jsdoc-and-tsdoc-comments-to-src-modules-3014869400
branch
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.
Closes #296
Applied changes based on Issue #296.
I’ve added missing TSDoc/JSDoc comments to all internal helpers and key exported functions across the
src/modules:• file/file.ts – documented
pathExists• file/images.ts – documented
downloadFile• api/openai.ts – documented
getOpenAIClient• github/action.ts – documented
escapeRegExp,createProgressComment,updateProgressComment, and enrichedhandleResultdocs• github/github.ts – documented
getBranchType,slugify,getEventType, and added parameter docs tocloneRepositoryThese should make the code much clearer for future maintainers without altering any existing behavior. Let me know if you’d like further adjustments!