8000 lib: remove erroneous JSDoc entry by Trott · Pull Request #41604 · nodejs/node · GitHub
[go: up one dir, main page]
Skip to content

lib: remove erroneous JSDoc entry #41604

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
Merged
Trott merged 1 commit into from
Jan 21, 2022
Merged

lib: remove erroneous JSDoc entry #41604

Trott merged 1 commit into from
Jan 21, 2022

Conversation

@Trott
Copy link
Member
@Trott Trott commented Jan 19, 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.)

@nodejs-github-bot nodejs-github-bot added the needs-ci PRs that need a full CI run. label Jan 19, 2022
@VoltrexKeyva
Copy link
Member
VoltrexKeyva commented Jan 20, 2022

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
Member Author
Trott commented Jan 20, 2022

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.

@Trott Trott 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-actions github-actions bot 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.

Sign in to view
@nodejs-github-bot
Copy link
Collaborator
nodejs-github-bot commented Jan 21, 2022

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

@Trott Trott added the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 21, 2022
@nodejs-github-bot nodejs-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
Collaborator
nodejs-github-bot commented Jan 21, 2022
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