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

Jump to bottom

node-api,doc: document parms which can be optional #41021

Closed
wants to merge 1 commit into from
Closed

node-api,doc: document parms which can be optional #41021

wants to merge 1 commit into from

Conversation

mhdawson
Copy link
Member

Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson mdawson@devrus.com

@mhdawson
node-api,doc: document parms which can be optional
4781570 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Nov 29, 2021
@mhdawson mhdawson mentioned this pull request Nov 29, 2021
Closed
@VoltrexKeyva
Copy link
Member

LGTM except for the typo in the commit message title. 😄

@mhdawson
Copy link
Member Author

@VoltrexMaster not sure what you mean by typo? parms is that way to make the 50 char limit.

@VoltrexKeyva
Copy link
Member

@VoltrexMaster not sure what you mean by typo? parms is that way to make the 50 char limit.

Oh, I thought you meant to put it as params, didn't know you did it for the 50 character limit. 😅

mhdawson added a commit that referenced this pull request Dec 3, 2021
@mhdawson
node-api,doc: document parms which can be optional
ea65e1f 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
@mhdawson
Copy link
Member Author

mhdawson commented Dec 3, 2021

Landed in ea65e1f

@mhdawson mhdawson closed this Dec 3, 2021
danielleadams pushed a commit that referenced this pull request Dec 13, 2021
@mhdawson @danielleadams
node-api,doc: document parms which can be optional
23b135d 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
danielleadams pushed a commit that referenced this pull request Dec 14, 2021
@mhdawson @danielleadams
node-api,doc: document parms which can be optional
6b6e1d0 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
@danielleadams danielleadams mentioned this pull request Dec 14, 2021
Merged
danielleadams pushed a commit that referenced this pull request Jan 31, 2022
@mhdawson @danielleadams
node-api,doc: document parms which can be optional
b86d54c 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
danielleadams pushed a commit that referenced this pull request Jan 31, 2022
@mhdawson @danielleadams
node-api,doc: document parms which can be optional
8ec81ea 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Linkgoron pushed a commit to Linkgoron/node that referenced this pull request Jan 31, 2022
@mhdawson @Linkgoron
node-api,doc: document parms which can be optional
f407820 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: nodejs#41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
danielleadams pushed a commit that referenced this pull request Feb 1, 2022
@mhdawson @danielleadams
node-api,doc: document parms which can be optional
375d04a 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
@danielleadams danielleadams mentioned this pull request Feb 1, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@lpinca lpinca lpinca approved these changes

@tniessen tniessen tniessen approved these changes

@VoltrexKeyva VoltrexKeyva VoltrexKeyva approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Specify when input pointers can be NULL
6 participants
@mhdawson @VoltrexKeyva @jasnell @lpinca @tniessen @nodejs-github-bot