Skip to content

doc: clarify behaviour of node-api adjust function #57463

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.

Sign up for GitHub

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
Merged
nodejs-github-bot merged 14 commits into from
Mar 28, 2025
Merged

doc: clarify behaviour of node-api adjust function #57463

nodejs-github-bot merged 14 commits into from
Mar 28, 2025

Conversation

@mhdawson
Copy link
Member

@mhdawson mhdawson commented Mar 14, 2025

Refs: #57351

  • based on recent request to update one of the tests

@mhdawson
doc: clarify behaviour of node-api adjust function
e998236 
Refs: nodejs#57351
- based on recent request to update one of the tests

Signed-off-by: Michael Dawson <[email protected]>
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 14, 2025

Review requested:

  • @nodejs/node-api

@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 Mar 14, 2025
lpinca
lpinca approved these changes Mar 15, 2025
View reviewed changes
legendecas
legendecas requested changes Mar 17, 2025
View reviewed changes
@legendecas legendecas mentioned this pull request Mar 17, 2025
Closed
mhdawson
mhdawson commented Mar 17, 2025
View reviewed changes
mhdawson
mhdawson commented Mar 17, 2025
View reviewed changes
vmoroz
vmoroz approved these changes Mar 17, 2025
View reviewed changes
Copy link
Member

@vmoroz vmoroz left a comment

Choose a reason for hiding this comment

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

LGTM

@mhdawson
squash: make linter happy
d4da3bf 
Signed-off-by: Michael Dawson <[email protected]>
legendecas
legendecas reviewed Mar 17, 2025
View reviewed changes
legendecas
legendecas reviewed Mar 19, 2025
View reviewed changes
mhdawson and others added 2 commits March 20, 2025 16:20
@mhdawson @legendecas
Update doc/api/n-api.md
d7aec7a 
Co-authored-by: Chengzhong Wu <[email protected]>
@mhdawson @legendecas
Update doc/api/n-api.md
0e3379e 
Co-authored-by: Chengzhong Wu <[email protected]>
mhdawson
mhdawson commented Mar 20, 2025
View reviewed changes
@mhdawson
Copy link
Member Author

mhdawson commented Mar 20, 2025

@legendecas accepted your suggestions and then tweaked again.

I am still wondering if we should include the comment about calling with -512 if you called with +512 before. If its ok to call +512 twice and then -1024 later I'm not sure we want to include that.

legendecas
legendecas approved these changes Mar 20, 2025
View reviewed changes
doc/api/n-api.md Outdated
often than it would otherwise.

This function is expected to be invoked symmetrically. If it is invoked with +512KB,
it is expected to be invoked -512KB in sum at a later time.
Copy link
Member

@legendecas legendecas Mar 20, 2025

Choose a reason for hiding this comment

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

I am still wondering if we should include the comment about calling with -512 if you called with +512 before. If its ok to call +512 twice and then -1024 later I'm not sure we want to include that.

"in sum" should address the concern? I think this sentence now is saying the value should be in symmetry.

@mhdawson
squash: make linter happy again
3753184 
Signed-off-by: Michael Dawson <[email protected]>
mhdawson
mhdawson commented Mar 21, 2025
View reviewed changes
mhdawson
mhdawson commented Mar 21, 2025
View reviewed changes
@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Mar 28, 2025
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Mar 28, 2025
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 28, 2025

Commit Queue failed
- Loading data for nodejs/node/pull/57463
✔  Done loading data for nodejs/node/pull/57463
----------------------------------- PR info ------------------------------------
Title      doc: clarify behaviour of node-api adjust function (#57463)
Author     Michael Dawson <[email protected]> (@mhdawson)
Branch     mhdawson:node-api-adjust-doc -> nodejs:main
Labels     doc, node-api, author ready
Commits    14
 - doc: clarify behaviour of node-api adjust function
 - Update doc/api/n-api.md
 - Update doc/api/n-api.md
 - squash: address comments
 - Update doc/api/n-api.md
 - Update doc/api/n-api.md
 - squash: make linter happy
 - Update doc/api/n-api.md
 - Update doc/api/n-api.md
 - Update doc/api/n-api.md
 - squash: make linter happy again
 - Update doc/api/n-api.md
 - Update doc/api/n-api.md
 - Update doc/api/n-api.md
Committers 2
 - Michael Dawson <[email protected]>
 - GitHub <[email protected]>
PR-URL: https://github.com/nodejs/node/pull/57463
Refs: https://github.com/nodejs/node/pull/57351
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Vladimir Morozov <[email protected]>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/57463
Refs: https://github.com/nodejs/node/pull/57351
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Vladimir Morozov <[email protected]>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Fri, 14 Mar 2025 16:33:21 GMT
   ✔  Approvals: 3
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/57463#pullrequestreview-2688093622
   ✔  - Chengzhong Wu (@legendecas) (TSC): https://github.com/nodejs/node/pull/57463#pullrequestreview-2708009128
   ✔  - Vladimir Morozov (@vmoroz): https://github.com/nodejs/node/pull/57463#pullrequestreview-2692160164
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
 * branch                  main       -> FETCH_HEAD
✔  origin/main is now up-to-date
- Downloading patch for 57463
From https://github.com/nodejs/node
 * branch                  refs/pull/57463/merge -> FETCH_HEAD
✔  Fetched commits as af75d04a76f1..0792c648255b
--------------------------------------------------------------------------------
[main 445d937f04] doc: clarify behaviour of node-api adjust function
 Author: Michael Dawson <[email protected]>
 Date: Fri Mar 14 16:31:39 2025 +0000
 1 file changed, 9 insertions(+), 5 deletions(-)
[main 309b4a8d5c] Update doc/api/n-api.md
 Author: Michael Dawson <[email protected]>
 Date: Mon Mar 17 11:05:35 2025 -0400
 1 file changed, 1 insertion(+), 1 deletion(-)
[main d26bae84e3] Update doc/api/n-api.md
 Author: Michael Dawson <[email protected]>
 Date: Mon Mar 17 11:07:01 2025 -0400
 1 file changed, 1 insertion(+), 1 deletion(-)
[main f25b0c9b60] squash: address comments
 Author: Michael Dawson <[email protected]>
 Date: Mon Mar 17 17:31:08 2025 -0400
 1 file changed, 4 insertions(+), 4 deletions(-)
[main d37760a389] Update doc/api/n-api.md
 Author: Michael Dawson <[email protected]>
 Date: Mon Mar 17 17:31:54 2025 -0400
 1 file changed, 1 insertion(+), 1 deletion(-)
[main a07cb6213b] Update doc/api/n-api.md
 Author: Michael Dawson <[email protected]>
 Date: Mon Mar 17 17:33:06 2025 -0400
 1 file changed, 1 insertion(+), 1 deletion(-)
[main 39ace7aa08] squash: make linter happy
 Author: Michael Dawson <[email protected]>
 Date: Mon Mar 17 21:59:59 2025 +0000
 1 file changed, 1 insertion(+), 1 deletion(-)
[main 9cb313079e] Update doc/api/n-api.md
 Author: Michael Dawson <[email protected]>
 Date: Thu Mar 20 16:20:28 2025 -0400
 1 file changed, 5 insertions(+), 4 deletions(-)
[main 40a46af5be] Update doc/api/n-api.md
 Author: Michael Dawson <[email protected]>
 Date: Thu Mar 20 16:20:40 2025 -0400
 1 file changed, 3 insertions(+)
[main 8cb12f5c27] Update doc/api/n-api.md
 Author: Michael Dawson <[email protected]>
 Date: Thu Mar 20 16:24:43 2025 -0400
 1 file changed, 3 insertions(+), 3 deletions(-)
[main 6dbbbe56d8] squash: make linter happy again
 Author: Michael Dawson <[email protected]>
 Date: Fri Mar 21 13:07:38 2025 +0000
 1 file changed, 3 insertions(+), 3 deletions(-)
[main 2a1f4efa75] Update doc/api/n-api.md
 Author: Michael Dawson <[email protected]>
 Date: Fri Mar 21 11:28:34 2025 -0400
 1 file changed, 3 insertions(+), 1 deletion(-)
[main 92379c52fb] Update doc/api/n-api.md
 Author: Michael Dawson <[email protected]>
 Date: Fri Mar 21 11:28:57 2025 -0400
 1 file changed, 1 deletion(-)
[main c81ea08ffb] Update doc/api/n-api.md
 Author: Michael Dawson <[email protected]>
 Date: Fri Mar 21 11:29:12 2025 -0400
 1 file changed, 3 insertions(+), 3 deletions(-)
   ✔  Patches applied
There are 14 commits in the PR. Attempting autorebase.
Rebasing (2/28)
Executing: git node land --amend --yes
   ⚠  Found Refs: https://github.com/nodejs/node/pull/57351, skipping..
--------------------------------- New Message ----------------------------------
doc: clarify behaviour of node-api adjust function

Refs: #57351


    

  • based on recent request to update one of the tests
    • 



Signed-off-by: Michael Dawson <[email protected]>

PR-URL: #57463

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 2c91b74144] doc: clarify behaviour of node-api adjust function

Author: Michael Dawson <[email protected]>

Date: Fri Mar 14 16:31:39 2025 +0000

1 file changed, 9 insertions(+), 5 deletions(-)

Rebasing (3/28)

Rebasing (4/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Update doc/api/n-api.md


Co-authored-by: Luigi Pinca <[email protected]>

PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 4518344fce] Update doc/api/n-api.md

Author: Michael Dawson <[email protected]>

Date: Mon Mar 17 11:05:35 2025 -0400

1 file changed, 1 insertion(+), 1 deletion(-)

Rebasing (5/28)

Rebasing (6/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Update doc/api/n-api.md


Co-authored-by: Luigi Pinca <[email protected]>

PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD f14f767de0] Update doc/api/n-api.md

Author: Michael Dawson <[email protected]>

Date: Mon Mar 17 11:07:01 2025 -0400

1 file changed, 1 insertion(+), 1 deletion(-)

Rebasing (7/28)

Rebasing (8/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

squash: address comments


PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 5c7a313b1a] squash: address comments

Author: Michael Dawson <[email protected]>

Date: Mon Mar 17 17:31:08 2025 -0400

1 file changed, 4 insertions(+), 4 deletions(-)

Rebasing (9/28)

Rebasing (10/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Update doc/api/n-api.md


PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 5581ec6461] Update doc/api/n-api.md

Author: Michael Dawson <[email protected]>

Date: Mon Mar 17 17:31:54 2025 -0400

1 file changed, 1 insertion(+), 1 deletion(-)

Rebasing (11/28)

Rebasing (12/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Update doc/api/n-api.md


PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 86149ae09a] Update doc/api/n-api.md

Author: Michael Dawson <[email protected]>

Date: Mon Mar 17 17:33:06 2025 -0400

1 file changed, 1 insertion(+), 1 deletion(-)

Rebasing (13/28)

Rebasing (14/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

squash: make linter happy


Signed-off-by: Michael Dawson <[email protected]>

PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 99cc30fe3d] squash: make linter happy

Author: Michael Dawson <[email protected]>

Date: Mon Mar 17 21:59:59 2025 +0000

1 file changed, 1 insertion(+), 1 deletion(-)

Rebasing (15/28)

Rebasing (16/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Update doc/api/n-api.md


Co-authored-by: Chengzhong Wu <[email protected]>

PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 548a6d2759] Update doc/api/n-api.md

Author: Michael Dawson <[email protected]>

Date: Thu Mar 20 16:20:28 2025 -0400

1 file changed, 5 insertions(+), 4 deletions(-)

Rebasing (17/28)

Rebasing (18/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Update doc/api/n-api.md


Co-authored-by: Chengzhong Wu <[email protected]>

PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD c31e1a8485] Update doc/api/n-api.md

Author: Michael Dawson <[email protected]>

Date: Thu Mar 20 16:20:40 2025 -0400

1 file changed, 3 insertions(+)

Rebasing (19/28)

Rebasing (20/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Update doc/api/n-api.md


PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 3f3c0ce114] Update doc/api/n-api.md

Author: Michael Dawson <[email protected]>

Date: Thu Mar 20 16:24:43 2025 -0400

1 file changed, 3 insertions(+), 3 deletions(-)

Rebasing (21/28)

Rebasing (22/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

squash: make linter happy again


Signed-off-by: Michael Dawson <[email protected]>

PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 2bd96c12c5] squash: make linter happy again

Author: Michael Dawson <[email protected]>

Date: Fri Mar 21 13:07:38 2025 +0000

1 file changed, 3 insertions(+), 3 deletions(-)

Rebasing (23/28)

Rebasing (24/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Update doc/api/n-api.md


PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 8391dd7080] Update doc/api/n-api.md

Author: Michael Dawson <[email protected]>

Date: Fri Mar 21 11:28:34 2025 -0400

1 file changed, 3 insertions(+), 1 deletion(-)

Rebasing (25/28)

Rebasing (26/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Update doc/api/n-api.md


PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 5ffe41d35d] Update doc/api/n-api.md

Author: Michael Dawson <[email protected]>

Date: Fri Mar 21 11:28:57 2025 -0400

1 file changed, 1 deletion(-)

Rebasing (27/28)

Rebasing (28/28)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Update doc/api/n-api.md


PR-URL: #57463

Refs: #57351

Reviewed-By: Luigi Pinca <[email protected]>

Reviewed-By: Chengzhong Wu <[email protected]>

Reviewed-By: Vladimir Morozov <[email protected]>


[detached HEAD 5e221cd453] Update doc/api/n-api.md

Author: Michael Dawson <[email protected]>

Date: Fri Mar 21 11:29:12 2025 -0400

1 file changed, 3 insertions(+), 3 deletions(-)

Successfully rebased and updated refs/heads/main.


ℹ  Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.
https://github.com/nodejs/node/actions/runs/14132066355

@aduh95 aduh95 added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Mar 28, 2025
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 28, 2025
@nodejs-github-bot nodejs-github-bot merged commit ca74d64 into nodejs:main Mar 28, 2025
34 checks passed
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Mar 28, 2025

Landed in ca74d64

@github-project-automation github-project-automation bot moved this from Need Triage to Done in Node-API Team Project Mar 28, 2025
@github-actions github-actions bot mentioned this pull request Mar 30, 2025
Merged
@RafaelGSS RafaelGSS mentioned this pull request Apr 8, 2025
Closed
@aduh95 aduh95 mentioned this pull request Apr 11, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vmoroz vmoroz vmoroz approved these changes

@lpinca lpinca lpinca approved these changes

@legendecas legendecas legendecas approved these changes

+1 more reviewer

@NickNaso NickNaso NickNaso approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.

Projects

Node-API Team Project
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@mhdawson @nodejs-github-bot @NickNaso @vmoroz @lpinca @legendecas @aduh95