fix(docs): fill JSDoc gaps flagged by validation gate#593
Merged
Raina451 merged 1 commit intoJul 13, 2026
Conversation
- Add missing @param/@returns to error type guards and getErrorDetails - Add JSDoc to createAgentWithMethods; fix stale @param name on createEntityWithMethods - Document QueueServiceModel.getById options param (model + service) and drop the unknown @Signature tag from getAll - Document ConversationSessionMethods params and the UiPath constructor - Mark internal telemetry exports and error-class constructors @internal Clears all notDocumented findings; npm run docs:validate exits 0. Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
Raina451
changed the title
Raina451
changed the base branch from
main
to
chore/jsdoc-completeness-validation
July 10, 2026 07:48
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
Raina451
marked this pull request as ready for review
July 10, 2026 07:52
|
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
vnaren23
approved these changes
Jul 10, 2026
swati354
approved these changes
Jul 13, 2026
Raina451
merged commit Jul 13, 2026
5dd3292
into
chore/jsdoc-completeness-validation
19 checks passed
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
3 participants
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.
What
Documents every public API gap surfaced by the JSDoc validation gate (#592), so
npm run docs:validateexits 0 and thejsdoc-validationCI check goes green.Fixes
Missing docs (documented):
isUiPathError,isAuthenticationError, …getErrorDetails) — added@param/@returnscreateAgentWithMethods— added the JSDoc block its 8 sibling factories already haveQueueServiceModel.getById/QueueService.getById— documented theoptionsparamConversationSessionMethods(startSession/getSession/endSession) — documented paramsUiPathconstructor — documentedconfigDoc bugs:
createEntityWithMethods—@param entityMetadatarenamed to the actual paramentityDataQueueServiceModel.getAll— removed the unknown@signatureblock tagInternal (excluded from public docs via
@internal):track,trackEvent,telemetryClient) — internal infraNotes
metaData has multiple declarations with a commentwarnings remain — a TypeDoc comment-merge quirk, not anotDocumentedfinding; exit code stays 0.typecheck+lintclean.Generated with Claude Code