Skip to content

doc: fix examples that fail as written - #67519

Closed
ParhamSaeedNia wants to merge 1 commit into
nodejs:mainfrom
ParhamSaeedNia:cursor/doc-api-example-fixes-cdc7
Closed

ParhamSaeedNia wants to merge 1 commit into
nodejs:mainfrom
ParhamSaeedNia:cursor/doc-api-example-fixes-cdc7

Conversation

@ParhamSaeedNia

Copy link
Copy Markdown

The configuration example set watch-preserve-output in two namespaces, which the parser rejects. Several API samples used the wrong identifier, the wrong Web IDL member, or a value shape the API does not return, so copying them threw or produced the wrong result.

The single-executable and duplex iterator pages are already correct on main and are left unchanged.

Fixes: #67518
Assisted-by: a closed-source coding agent

The configuration example set watch-preserve-output in two
namespaces, which the parser rejects. Several API samples
used the wrong identifier, the wrong Web IDL member, or a
value shape the API does not return, so copying them threw
or produced the wrong result.

The single-executable and duplex iterator pages are already
correct on main and are left unchanged.

Fixes: nodejs#67518
Assisted-by: a closed-source coding agent
Co-authored-by: Parham Saeednia <ParhamSaeedNia@users.noreply.github.com>
Signed-off-by: Parham Saeednia <saeedniaparham@gmail.com>
Signed-off-by: Parham Saeednia <ParhamSaeedNia@users.noreply.github.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/crypto
  • @nodejs/loaders
  • @nodejs/node-api
  • @nodejs/test_runner
  • @nodejs/userland-migrations

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to Node.js documentation. label Nov 16, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Welcome to Node.js, and thank you for your first contribution!

Before review, please take a moment to read:

Please make sure every commit is signed off. For a first pull request, GitHub Actions require collaborator approval and Jenkins CI must be started by a collaborator or triager, so an initial wait is normal.

@cursor
cursor Bot deleted the cursor/doc-api-example-fixes-cdc7 branch November 16, 2026 12:52
@cursor
cursor Bot restored the cursor/doc-api-example-fixes-cdc7 branch November 16, 2026 12:53
@aduh95

aduh95 commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

This would need to be several PRs

@aduh95 aduh95 closed this Nov 16, 2026
@MikeMcC399

Copy link
Copy Markdown
Member

Bundling unrelated fixes together, even if it is "only" for documentation, would make it very difficult to review. It could also be that some parts would be accepted, others would need changes and theoretically some changes could be rejected. That needs to be independent. This is the reason for needing several PRs.

Please note also that first-time contributors are restricted to one open PR at a time.

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 Node.js documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: errors in the v24 API reference (audited v24.22.1, re-checked against v24.22.3)

4 participants