Skip to content

doc: fix typos in documentation#64466

Merged
aduh95 merged 1 commit into
nodejs:mainfrom
sjungwon03:docs/improve-writing-docs
Jul 13, 2026
Merged

doc: fix typos in documentation#64466
aduh95 merged 1 commit into
nodejs:mainfrom
sjungwon03:docs/improve-writing-docs

Conversation

@sjungwon03

Copy link
Copy Markdown
Contributor

This fixes a handful of small typos I noticed while reading through the docs.

doc/api/deprecations.md and doc/api/errors.md:

- that have proven unresolveable.
+ that have proven unresolvable.

- Type stripping is not supported for files descendent of a `node_modules` directory.
+ Type stripping is not supported for files descendant of a `node_modules` directory.

doc/api/n-api.md had a misspelling in the reference to the ECMAScript
IsStrictlyEqual
operation. Renamed the reference label as well.

- defined in [Section IsStrctEqual][] of the ECMAScript Language Specification.
+ defined in [Section IsStrictlyEqual][] of the ECMAScript Language Specification.

Also changed writeable to writable in the N-API and stream docs. This is
consistent with napi_writable, Writable, and WritableStream.

- configurable and writeable, but not enumerable.
+ configurable and writable, but not enumerable.

- Attaches an AbortSignal to a readable or writeable stream.
+ Attaches an AbortSignal to a readable or writable stream.

- on the writeable stream.
+ on the writable stream.

The remaining changes are straightforward spelling fixes:

- Be mindfull of your asks for their time
+ Be mindful of your asks for their time

- When triagging issues and PRs:
+ When triaging issues and PRs:

- the tools and verions are documented through metadata
+ the tools and versions are documented through metadata

- a dark, mysterious, and forboding subject
+ a dark, mysterious, and foreboding subject

Fix typographical errors in API, contributor, and crypto docs.

Signed-off-by: sjungwon03 <sjungwon03@gmail.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/crypto
  • @nodejs/node-api
  • @nodejs/tsc
  • @nodejs/userland-migrations

@nodejs-github-bot nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. crypto Issues and PRs related to the crypto subsystem. needs-ci PRs that need a full CI run. labels Jul 13, 2026
@aduh95 aduh95 added doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 72 hours to land. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed crypto Issues and PRs related to the crypto subsystem. c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run. labels Jul 13, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Fast-track has been requested by @aduh95. Please 👍 to approve.

@aduh95 aduh95 merged commit 1314579 into nodejs:main Jul 13, 2026
39 checks passed
@aduh95

aduh95 commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Landed in 1314579

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 72 hours to land.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants