Skip to content

docs(worker): improve JSDoc and strengthen error handling #5320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

docs(worker): improve JSDoc and strengthen error handling #5320

wants to merge 8 commits into from
+93 −20

Conversation

KushalMeghani1644
Copy link

docs(worker): improve JSDoc and error handling in cpu-profile-summarizer

@KushalMeghani1644
docs(worker): improve JSDoc and strengthen error handling
87897f6 
- Added detailed JSDoc comments for better clarity and maintainability
- Narrowed  to properly handle Error vs non-Error cases
- Removed unused  field from ILocalTimeInfo
@github-project-automation github-project-automation bot moved this to Needs triage in Bug Triage Aug 25, 2025
@KushalMeghani1644
Copy link
Author

@microsoft-github-policy-service agree

@iclanton
Copy link
Member

You're missing a changelog entry. Can you run rush change and provide a summary of your change, and then check in the file that it generates?

@iclanton iclanton moved this from Needs triage to In Progress in Bug Triage Aug 27, 2025
@KushalMeghani1644
Copy link
Author

Hey @iclanton I have added the changelog file as you requested.

iclanton
iclanton reviewed Aug 28, 2025
View reviewed changes
@KushalMeghani1644
Copy link
Author

@iclanton I removed the explicit type since TypeScript can infer that i is a number from the initialization. However, I understand if you prefer declaring types explicitly, I have added it back though, as suggested by you :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@octogonz octogonz Awaiting requested review from octogonz octogonz is a code owner

@apostolisms apostolisms Awaiting requested review from apostolisms apostolisms is a code owner

@D4N14L D4N14L Awaiting requested review from D4N14L D4N14L is a code owner

@dmichon-msft dmichon-msft Awaiting requested review from dmichon-msft dmichon-msft is a code owner

@iclanton iclanton Awaiting requested review from iclanton iclanton is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
Bug Triage
Status: In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@KushalMeghani1644 @iclanton