Skip to content

doc: fix some typos in N-API docs - #21614

Closed
vsemozhetbyt wants to merge 1 commit into
nodejs:masterfrom
vsemozhetbyt:doc-napi-async
Closed

doc: fix some typos in N-API docs#21614
vsemozhetbyt wants to merge 1 commit into
nodejs:masterfrom
vsemozhetbyt:doc-napi-async

Conversation

@vsemozhetbyt

Copy link
Copy Markdown
Contributor
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot

This comment has been minimized.

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Jul 1, 2018
@vsemozhetbytvsemozhetbyt added errors Issues and PRs related to JavaScript errors originated in Node.js core. node-api Issues and PRs related to the Node-API. labels Jul 1, 2018
@vsemozhetbyt

Copy link
Copy Markdown
ContributorAuthor

Node.js Collaborators, please, add 👍 here if you approve fast-tracking.

@vsemozhetbytvsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jul 1, 2018
Comment threaddoc/api/n-api.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It's restuls and not context in the source code (src/node_api.h and src/node_api.cc). Those should be updated to match as well?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

If so, please, anybody familiar with C++, push a commit in this PR or suggest a diff. I am afraid to break something)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@vsemozhetbyt just keep result, it matches with the signature in src/node_api.h.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Should I replace context with result then in options below so that the signature matches options?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes correct.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Done.

@vsemozhetbyt

Copy link
Copy Markdown
ContributorAuthor

@vsemozhetbytvsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label Jul 1, 2018
@vsemozhetbyt

Copy link
Copy Markdown
ContributorAuthor

Landed in 484c6c3
Thank you for the reviews.

@vsemozhetbyt
vsemozhetbyt deleted the doc-napi-async branch July 1, 2018 21:53
vsemozhetbyt added a commit that referenced this pull request Jul 1, 2018
PR-URL: #21614
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
targos pushed a commit that referenced this pull request Jul 3, 2018
PR-URL: #21614
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@targostargos mentioned this pull request Jul 3, 2018
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.errorsIssues and PRs related to JavaScript errors originated in Node.js core.fast-trackPRs that do not need to wait for 48 hours to land.node-apiIssues and PRs related to the Node-API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@vsemozhetbyt@nodejs-github-bot@Trott@lpinca@cjihrig@hiroppy@starkwang@trivikr