Skip to content

doc: fix misaligned options in vm.compileFunction() - #58145

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
hkleungai:doc-api-vm-fix-compileFunction-options-importModuleDynamically
May 5, 2025
Merged

doc: fix misaligned options in vm.compileFunction()#58145
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
hkleungai:doc-api-vm-fix-compileFunction-options-importModuleDynamically

Conversation

@hkleungai

Copy link
Copy Markdown
Contributor

Current alignment mislead doc reader into thinking
importModuleDynamically is a separate positional param right next to
options, which is incorrect and need to be fixed.

This misalignment is introduced in a PR merged in Feb 2024.

I belive this doc fix applies to node v20 and above.

Refs: #51244

Current alignment mislead doc reader into thinking
`importModuleDynamically` is a separate positional param right next to
`options`, which is incorrect and need to be fixed.
This misalignment is introduced in a PR merged in Feb 2024.
I belive this doc fix applies to node v20 and above.
Refs: nodejs#51244
@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. vm Issues and PRs related to the vm subsystem. labels May 3, 2025
@RaisinTenRaisinTen 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 May 4, 2025
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 5, 2025
@nodejs-github-bot
nodejs-github-bot merged commit f275121 into nodejs:mainMay 5, 2025
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in f275121

@hkleungai
hkleungai deleted the doc-api-vm-fix-compileFunction-options-importModuleDynamically branch May 5, 2025 19:32
aduh95 pushed a commit that referenced this pull request May 8, 2025
Current alignment mislead doc reader into thinking
`importModuleDynamically` is a separate positional param right next to
`options`, which is incorrect and need to be fixed.
This misalignment is introduced in a PR merged in Feb 2024.
I belive this doc fix applies to node v20 and above.
Refs: #51244
PR-URL: #58145
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
aduh95 pushed a commit that referenced this pull request May 19, 2025
Current alignment mislead doc reader into thinking
`importModuleDynamically` is a separate positional param right next to
`options`, which is incorrect and need to be fixed.
This misalignment is introduced in a PR merged in Feb 2024.
I belive this doc fix applies to node v20 and above.
Refs: #51244
PR-URL: #58145
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
marco-ippolito pushed a commit that referenced this pull request Jun 5, 2025
Current alignment mislead doc reader into thinking
`importModuleDynamically` is a separate positional param right next to
`options`, which is incorrect and need to be fixed.
This misalignment is introduced in a PR merged in Feb 2024.
I belive this doc fix applies to node v20 and above.
Refs: #51244
PR-URL: #58145
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
marco-ippolito pushed a commit that referenced this pull request Jun 5, 2025
Current alignment mislead doc reader into thinking
`importModuleDynamically` is a separate positional param right next to
`options`, which is incorrect and need to be fixed.
This misalignment is introduced in a PR merged in Feb 2024.
I belive this doc fix applies to node v20 and above.
Refs: #51244
PR-URL: #58145
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
@marco-ippolitomarco-ippolito mentioned this pull request Jun 5, 2025
@ghostghost mentioned this pull request Jun 8, 2025
marco-ippolito pushed a commit that referenced this pull request Jun 10, 2025
Current alignment mislead doc reader into thinking
`importModuleDynamically` is a separate positional param right next to
`options`, which is incorrect and need to be fixed.
This misalignment is introduced in a PR merged in Feb 2024.
I belive this doc fix applies to node v20 and above.
Refs: #51244
PR-URL: #58145
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
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.vmIssues and PRs related to the vm subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@hkleungai@nodejs-github-bot@daeyeon@RaisinTen