Skip to content

lib: remove erroneous JSDoc entry - #41604

Merged
Trott merged 1 commit into
nodejs:masterfrom
Trott:jsdoc-class
Jan 21, 2022
Merged

lib: remove erroneous JSDoc entry#41604
Trott merged 1 commit into
nodejs:masterfrom
Trott:jsdoc-class

Conversation

@Trott

Copy link
Copy Markdown
Member

The entry contains incorrect parameters and duplicates the subsequent
constructor entry. Remove it.

(I'm not sure why this is being caught by the linter on my local machine
but not in CI.)

@nodejs-github-botnodejs-github-bot added the needs-ci PRs that need a full CI run. label Jan 19, 2022
@VoltrexKeyva

Copy link
Copy Markdown
Contributor

I think we should also move the description of the constructor to the JSDoc entry on top of constructor() method and remove the JSDoc entry from the top of the class entirely.

@Trott

Copy link
Copy Markdown
MemberAuthor

I think we should also move the description of the constructor to the JSDoc entry on top of constructor() method and remove the JSDoc entry from the top of the class entirely.

I'll do that if you or others feel strongly about it. It seems more intuitive to me to have the description of the class where it is now. The examples at https://jsdoc.app/howto-es2015-classes.html do it that way too.

@TrottTrott added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Jan 20, 2022
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jan 21, 2022
@nodejs-github-bot

This comment has been minimized.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@TrottTrott added the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 21, 2022
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 21, 2022
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator
Commit Queue failed
- Loading data for nodejs/node/pull/41604
✔ Done loading data for nodejs/node/pull/41604
----------------------------------- PR info ------------------------------------
Title lib: remove erroneous JSDoc entry (#41604)
Author Rich Trott (@Trott)
Branch Trott:jsdoc-class -> nodejs:master
Labels author ready, needs-ci
Commits 1
- lib: remove erroneous JSDoc entry
Committers 1
- Rich Trott PR-URL: https://github.com/nodejs/node/pull/41604
Reviewed-By: Mestery Reviewed-By: Mohammed Keyvanzadeh ------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/41604
Reviewed-By: Mestery Reviewed-By: Mohammed Keyvanzadeh --------------------------------------------------------------------------------
ℹ This PR was created on Wed, 19 Jan 2022 22:12:37 GMT
✔ Approvals: 2
✔ - Mestery (@Mesteery): https://github.com/nodejs/node/pull/41604#pullrequestreview-857763183
✔ - Mohammed Keyvanzadeh (@VoltrexMaster): https://github.com/nodejs/node/pull/41604#pullrequestreview-858607620
✖ GitHub CI is still running
ℹ Last Full PR CI on 2022-01-21T17:29:57Z: https://ci.nodejs.org/job/node-test-pull-request/42071/
- Querying data for job/node-test-pull-request/42071/
✔ Last Jenkins CI successful
--------------------------------------------------------------------------------
✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/1731079247

@nodejs-github-botnodejs-github-bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Jan 21, 2022
The entry contains incorrect parameters and duplicates the subsequent
constructor entry. Remove it.
(I'm not sure why this is being caught by the linter on my local machine
but not in CI.)
PR-URL: nodejs#41604
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
@Trott

Copy link
Copy Markdown
MemberAuthor

Landed in 290911b

@Trott
Trott merged commit 290911b into nodejs:masterJan 21, 2022
@Trott
Trott deleted the jsdoc-class branch January 21, 2022 22:38
BethGriggs pushed a commit that referenced this pull request Jan 25, 2022
The entry contains incorrect parameters and duplicates the subsequent
constructor entry. Remove it.
(I'm not sure why this is being caught by the linter on my local machine
but not in CI.)
PR-URL: #41604
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
@ruyadornoruyadorno mentioned this pull request Feb 8, 2022
danielleadams pushed a commit that referenced this pull request Feb 28, 2022
The entry contains incorrect parameters and duplicates the subsequent
constructor entry. Remove it.
(I'm not sure why this is being caught by the linter on my local machine
but not in CI.)
PR-URL: #41604
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
danielleadams pushed a commit that referenced this pull request Mar 2, 2022
The entry contains incorrect parameters and duplicates the subsequent
constructor entry. Remove it.
(I'm not sure why this is being caught by the linter on my local machine
but not in CI.)
PR-URL: #41604
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
danielleadams pushed a commit that referenced this pull request Mar 3, 2022
The entry contains incorrect parameters and duplicates the subsequent
constructor entry. Remove it.
(I'm not sure why this is being caught by the linter on my local machine
but not in CI.)
PR-URL: #41604
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
danielleadams pushed a commit that referenced this pull request Mar 14, 2022
The entry contains incorrect parameters and duplicates the subsequent
constructor entry. Remove it.
(I'm not sure why this is being caught by the linter on my local machine
but not in CI.)
PR-URL: #41604
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.commit-queue-failedAn error occurred while landing this pull request using GitHub Actions.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Trott@VoltrexKeyva@nodejs-github-bot@Mesteery