Skip to content

Conversation

mhdawson
Copy link
Member

Document the lifetime of the structure returned
by napi_get_last_error_info

Fixes: nodejs/abi-stable-node#251

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, n-api

Document the lifetime of the structure returned
by napi_get_last_error_info

Fixes: nodejs/abi-stable-node#251
@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 Jun 26, 2017
doc/api/n-api.md Outdated
@@ -269,6 +269,9 @@ Returns `napi_ok` if the API succeeded.
This API retrieves a `napi_extended_error_info` structure with information
about the last error that occurred.

*Note*: The content of the 'napi_extended_error_info` returned is only
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong quote before napi_?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks ! Pushed commit to fix.

Copy link
Contributor

@digitalinfinity digitalinfinity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see the same issue as @vsemozhetbyt - other than that LGTM

Copy link
Contributor

@cjihrig cjihrig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with the quote nit addressed.

@mhdawson
Copy link
Member Author

@mhdawson
Copy link
Member Author

CI good landing.

@mhdawson
Copy link
Member Author

Landed as ef28d85

@mhdawson mhdawson closed this Jun 28, 2017
mhdawson added a commit that referenced this pull request Jun 28, 2017
Document the lifetime of the structure returned
by napi_get_last_error_info

PR-URL: #13939
Fixes: nodejs/abi-stable-node#251
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Hitesh Kanwathirtha <digitalinfinity@gmail.com>
addaleax pushed a commit that referenced this pull request Jun 29, 2017
Document the lifetime of the structure returned
by napi_get_last_error_info

PR-URL: #13939
Fixes: nodejs/abi-stable-node#251
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Hitesh Kanwathirtha <digitalinfinity@gmail.com>
@addaleax addaleax mentioned this pull request Jun 29, 2017
addaleax pushed a commit that referenced this pull request Jul 11, 2017
Document the lifetime of the structure returned
by napi_get_last_error_info

PR-URL: #13939
Fixes: nodejs/abi-stable-node#251
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Hitesh Kanwathirtha <digitalinfinity@gmail.com>
addaleax pushed a commit that referenced this pull request Jul 18, 2017
Document the lifetime of the structure returned
by napi_get_last_error_info

PR-URL: #13939
Fixes: nodejs/abi-stable-node#251
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Hitesh Kanwathirtha <digitalinfinity@gmail.com>
gabrielschulhof pushed a commit to gabrielschulhof/node that referenced this pull request Apr 10, 2018
Document the lifetime of the structure returned
by napi_get_last_error_info

PR-URL: nodejs#13939
Fixes: nodejs/abi-stable-node#251
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Hitesh Kanwathirtha <digitalinfinity@gmail.com>
MylesBorins pushed a commit that referenced this pull request Apr 16, 2018
Document the lifetime of the structure returned
by napi_get_last_error_info

Backport-PR-URL: #19447
PR-URL: #13939
Fixes: nodejs/abi-stable-node#251
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Hitesh Kanwathirtha <digitalinfinity@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Apr 16, 2018
@mhdawson mhdawson deleted the napi-doc-lifetime branch September 30, 2019 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants