lib: apply same style to param in JSDoc #46010
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This isn't a typo, it marks the parameter as optional, there are multiple ways to mark a parameter as optional in JSDoc:
But I think we should use the third option for consistency if anything. |
`?object` -> `[object]`
deokjinkim
force-pushed
the
221229_fix_typo_options
branch
from
11f6b43
to
d7309d9
Compare
deokjinkim
changed the title
VoltrexKeyva
approved these changes
Dec 29, 2022
|
I thought option 3 is only available. Thank you for correction. Applied your suggestion. |
aduh95
reviewed
Dec 29, 2022
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
aduh95
approved these changes
Dec 29, 2022
aduh95
added
author ready
anonrig
approved these changes
Dec 30, 2022
targos
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
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/.ncuhttps://github.com/nodejs/node/actions/runs/3816493648 |
nodejs-github-bot
added
the
commit-queue-failed
github-actions
bot
removed
the
request-ci
|
Landed in c87a197 |
22 tasks
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>
Merged
This was referenced Jan 3, 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>
22 tasks
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>
Merged
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
?object->[object]