Skip to content
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.

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

lib: apply same style to param in JSDoc #46010

Merged
merged 2 commits into from
Jan 1, 2023

Conversation

deokjinkim
Copy link
Contributor

@deokjinkim deokjinkim commented Dec 29, 2022

?object -> [object]

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

VoltrexKeyva commented Dec 29, 2022

This isn't a typo, it marks the parameter as optional, there are multiple ways to mark a parameter as optional in JSDoc:

  1. @param {?Foo} foo (used here)
  2. @param {Foo?} foo
  3. @param {Foo} [foo]

But I think we should use the third option for consistency if anything.

@deokjinkim deokjinkim changed the title lib: fix typo of param in JSDoc lib: apply same style to param in JSDoc Dec 29, 2022
@deokjinkim
Copy link
Contributor Author

deokjinkim commented Dec 29, 2022

I thought option 3 is only available. Thank you for correction. Applied your suggestion.

lib/internal/validators.js Outdated Show resolved Hide resolved
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed needs-ci PRs that need a full CI run. labels Dec 29, 2022
@targos targos added the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 1, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 1, 2023
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/46010
✔  Done loading data for nodejs/node/pull/46010
----------------------------------- PR info ------------------------------------
Title      lib: apply same style to param in JSDoc (#46010)
Author     Deokjin Kim  (@deokjinkim)
Branch     deokjinkim:221229_fix_typo_options -> nodejs:main
Labels     author ready
Commits    2
 - lib: apply same style to param in JSDoc
 - Change data type to any
Committers 2
 - Deokjin Kim 
 - GitHub 
PR-URL: https://github.com/nodejs/node/pull/46010
Reviewed-By: Mohammed Keyvanzadeh 
Reviewed-By: Antoine du Hamel 
Reviewed-By: Yagiz Nizipli 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/46010
Reviewed-By: Mohammed Keyvanzadeh 
Reviewed-By: Antoine du Hamel 
Reviewed-By: Yagiz Nizipli 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Thu, 29 Dec 2022 05:58:20 GMT
   ✔  Approvals: 3
   ✔  - Mohammed Keyvanzadeh (@VoltrexKeyva): https://github.com/nodejs/node/pull/46010#pullrequestreview-1232232059
   ✔  - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/46010#pullrequestreview-1232363217
   ✔  - Yagiz Nizipli (@anonrig): https://github.com/nodejs/node/pull/46010#pullrequestreview-1232827738
   ✔  Last GitHub CI successful
   ✖  No Jenkins CI runs detected
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/3816493648

@nodejs-github-bot nodejs-github-bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Jan 1, 2023
@targos targos added the request-ci Add this label to start a Jenkins CI on a PR. label Jan 1, 2023
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jan 1, 2023
@nodejs-github-bot
Copy link
Collaborator

@aduh95 aduh95 merged commit c87a197 into nodejs:main Jan 1, 2023
@aduh95
Copy link
Contributor

aduh95 commented Jan 1, 2023

Landed in c87a197

RafaelGSS pushed a commit that referenced this pull request Jan 2, 2023
PR-URL: #46010
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
@RafaelGSS RafaelGSS mentioned this pull request Jan 2, 2023
RafaelGSS pushed a commit that referenced this pull request Jan 4, 2023
PR-URL: #46010
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
RafaelGSS pushed a commit that referenced this pull request Jan 5, 2023
PR-URL: #46010
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
juanarbol pushed a commit that referenced this pull request Jan 26, 2023
PR-URL: #46010
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
@juanarbol juanarbol mentioned this pull request Jan 28, 2023
juanarbol pushed a commit that referenced this pull request Jan 31, 2023
PR-URL: #46010
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-failed An error occurred while landing this pull request using GitHub Actions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants