Skip to content

test_runner: add jsdocs to MockFunctionContext and MockTracker - #49555

Merged
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
ocodista:main
Sep 14, 2023
Merged

test_runner: add jsdocs to MockFunctionContext and MockTracker#49555
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
ocodista:main

Conversation

@ocodista

@ocodistaocodista commented Sep 8, 2023

Copy link
Copy Markdown
Contributor

Add JSDocs for all public functions of MockFunctionContext

cc @nodejs/test_runner

@nodejs-github-bot

nodejs-github-bot commented Sep 8, 2023•
edited by ErickWendel
Loading

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/test_runner

@nodejs-github-botnodejs-github-bot added needs-ci PRs that need a full CI run. test_runner Issues and PRs related to the test runner subsystem. labels Sep 8, 2023
@ocodistaocodista changed the title test_runner: add jsdocs to MockFunctionContexttest_runner: add jsdocs to MockFunctionContext and MockTrackerSep 8, 2023
ErickWendel
ErickWendel requested changes Sep 8, 2023
View reviewed changes
Comment threadlib/internal/test_runner/mock/mock.js Outdated
Comment threadlib/internal/test_runner/mock/mock.js Outdated
Comment threadlib/internal/test_runner/mock/mock.js Outdated
Comment threadlib/internal/test_runner/mock/mock.js Outdated
Comment threadlib/internal/test_runner/mock/mock.js Outdated
Comment threadlib/internal/test_runner/mock/mock.js Outdated
Comment threadlib/internal/test_runner/mock/mock.js Outdated
Comment threadlib/internal/test_runner/mock/mock.js Outdated
Comment threadlib/internal/test_runner/mock/mock.js Outdated
Comment threadlib/internal/test_runner/mock/mock.js Outdated
@ErickWendel

ErickWendel commented Sep 8, 2023

Copy link
Copy Markdown
Member

@ocodista Also, don't forget to add jsdocs for constructors, getters, and setters and everything that would be accessible on the public API

@ocodista

ocodista commented Sep 8, 2023

Copy link
Copy Markdown
ContributorAuthor

@ErickWendel Thank you for the notes and reviews, I applied all the naming suggestions and included jsdocs for the getter/setter and get times function. Please take a new look whenever you have some time.

@benjamingr

benjamingr commented Sep 10, 2023

Copy link
Copy Markdown
Member

Hey thanks for your contribution 🙇 please revert all the unrelated style changes and keep the JSDoc stuff?

@ocodista

ocodista commented Sep 10, 2023

Copy link
Copy Markdown
ContributorAuthor

Hey thanks for your contribution 🙇 please revert all the unrelated style changes and keep the JSDoc stuff?

Thank you!

Just did it 😁

ErickWendel
ErickWendel requested changes Sep 12, 2023
View reviewed changes
Comment threadlib/internal/test_runner/mock/mock.js Outdated
ErickWendel
ErickWendel requested changes Sep 12, 2023
View reviewed changes
Comment threadlib/internal/test_runner/mock/mock.js Outdated
ErickWendel
ErickWendel approved these changes Sep 13, 2023
View reviewed changes

@ErickWendelErickWendel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ErickWendelErickWendel added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 13, 2023
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 13, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 13, 2023

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/53925/

atlowChemi
atlowChemi approved these changes Sep 13, 2023
View reviewed changes

@atlowChemiatlowChemi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM, thanks for this contribution 🙂

Comment threadlib/internal/test_runner/mock/mock.js Outdated
@ocodista@atlowChemi
Update lib/internal/test_runner/mock/mock.js
794a162
Co-authored-by: Chemi Atlow <chemi@atlow.co.il>
@atlowChemiatlowChemi added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 13, 2023
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 13, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 13, 2023

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/53929/

@nodejs-github-bot

nodejs-github-bot commented Sep 13, 2023

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/53935/

@github-actionsgithub-actionsBot mentioned this pull request Sep 14, 2023
Open
15 tasks
@ocodista

ocodista commented Sep 14, 2023

Copy link
Copy Markdown
ContributorAuthor

Overall LGTM, thanks for this contribution 🙂

Thank you!!!

@atlowChemiatlowChemi added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 14, 2023
@atlowChemiatlowChemi added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Sep 14, 2023
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 14, 2023
@nodejs-github-bot
nodejs-github-bot merged commit 4efa374 into nodejs:mainSep 14, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 14, 2023

Copy link
Copy Markdown
Collaborator

Landed in 4efa374

This was referenced Sep 15, 2023
Open
Open
Open
Open
ruyadorno pushed a commit that referenced this pull request Sep 28, 2023
@ocodista@ruyadorno
test_runner: add jsdocs to mock.js
5672e38
PR-URL: #49555
Reviewed-By: Erick Wendel <erick.workspace@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
This was referenced Sep 28, 2023
Closed
Merged
targos pushed a commit that referenced this pull request Nov 27, 2023
@ocodista@targos
test_runner: add jsdocs to mock.js
76a3563
PR-URL: #49555
Reviewed-By: Erick Wendel <erick.workspace@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
@targostargos mentioned this pull request Nov 28, 2023
Merged
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
@sercher
test_runner: add jsdocs to mock.js
47b5f21
PR-URL: nodejs/node#49555
Reviewed-By: Erick Wendel <erick.workspace@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
@sercher
test_runner: add jsdocs to mock.js
5efedab
PR-URL: nodejs/node#49555
Reviewed-By: Erick Wendel <erick.workspace@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ErickWendelErickWendelErickWendel approved these changes
@atlowChemiatlowChemiatlowChemi approved these changes

Assignees

No one assigned

Labels

commit-queue-squashAdd this label to instruct the Commit Queue to squash all the PR commits into the first one.needs-ciPRs that need a full CI run.test_runnerIssues and PRs related to the test runner subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@ocodista@nodejs-github-bot@ErickWendel@benjamingr@atlowChemi