Skip to content

docs: fix heading levels - #16624

Merged
kgryte merged 4 commits into
developfrom
claude/cool-johnson-c92dlq
Nov 14, 2026
Merged

kgryte merged 4 commits into
developfrom
claude/cool-johnson-c92dlq

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • promotes API signature headings in four array/base READMEs from ### to ####, which is the heading level used across the namespace.

Namespace summary. array/base has 242 members and no autogenerated packages. The scan covered 11 features: file tree, package.json keys, scripts/stdlib/manifest.json keys, README section set and order, error construction, JSDoc @returns/@example, lib/index.js @module/@example, and require dependencies. Excluded for lack of a clear majority (≥75%): error construction among the 18 packages that throw (9 format, 8 static plain-string, 1 mixed), and ## Notes presence (62%).

array/base/take-map

Both takeMap and takeMap.assign headings were ###. Main signature headings are #### in 237 of 238 array/base packages (99.6%), and .assign headings are #### in 36 of 40 (90%). Both now use ####.

array/base/to-inserted-at

toInsertedAt.assign was ### while the toInsertedAt heading in the same README is ####. It now uses ####, the level used for .assign headings in 36 of 40 packages (90%).

array/base/with

arrayWith.assign was ### while the arrayWith heading is ####. It now uses #### (36 of 40 packages, 90%).

array/base/without

without.assign was ### while the without heading is ####. It now uses #### (36 of 40 packages, 90%).

Related Issues

Does this pull request have any related issues?

None.

Reference Packages

Did the content of this pull request follow one or more existing packages? Answering is optional.

This pull request followed these packages:

  • array/base/take, array/base/map2d, array/base/filled-by

What carried over from the reference(s)?

  • Heading level for API signatures (####).

What differed, or what did you have to work out yourself?

  • Nothing.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Validation. Features were extracted from all 242 members by a filesystem/string pass and a semantic pass over lib/main.js, lib/index.js, and lib/validate.js. The heading finding was then checked by two independent reviews: a structural review confirming #### is the stdlib-wide convention, and a cross-reference review confirming that no tests, tooling, or anchor links depend on heading level (remark-lint-heading-increment is currently off). Deliberately excluded: the namespace packages assert, banded, symmetric, and symmetric-banded, which intentionally lack lib/main.js and docs/repl.txt; per-package unique files and sections, which reflect real API differences; and generator-owned sections. Each package has its own commit.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

This PR was written primarily by Claude Code, as part of an automated cross-package drift-detection run over array/base.



Generated by Claude Code

…map`

Changed `takeMap` and `takeMap.assign` signature headings from `###` to `####`, matching 237 of 238 `array/base` packages for main signature headings (99.6%) and 36 of 40 for `.assign` headings (90%).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017wWD77qdNe61BaVDicjDkh
…se/to-inserted-at`

Changed the `toInsertedAt.assign` signature heading from `###` to `####`, matching the main `toInsertedAt` heading in the same README and 36 of 40 `array/base` packages documenting an `.assign` method (90%).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017wWD77qdNe61BaVDicjDkh
…with`

Changed the `arrayWith.assign` signature heading from `###` to `####`, matching the main `arrayWith` heading in the same README and 36 of 40 `array/base` packages documenting an `.assign` method (90%).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017wWD77qdNe61BaVDicjDkh
…thout`

Changed the `without.assign` signature heading from `###` to `####`, matching the main `without` heading in the same README and 36 of 40 `array/base` packages documenting an `.assign` method (90%).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017wWD77qdNe61BaVDicjDkh
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
array/base/take-map $\\color{green}431/431$
$\\color{green}+100.00\\%$
$\\color{green}23/23$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}431/431$
$\\color{green}+100.00\\%$
array/base/to-inserted-at $\\color{green}372/372$
$\\color{green}+100.00\\%$
$\\color{green}34/34$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}372/372$
$\\color{green}+100.00\\%$
array/base/with $\\color{green}382/382$
$\\color{green}+100.00\\%$
$\\color{green}27/27$
$\\color{green}+100.00\\%$
$\\color{green}6/6$
$\\color{green}+100.00\\%$
$\\color{green}382/382$
$\\color{green}+100.00\\%$
array/base/without $\\color{green}350/350$
$\\color{green}+100.00\\%$
$\\color{green}33/33$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}350/350$
$\\color{green}+100.00\\%$

The above coverage report was generated for the changes in this PR.

@kgryte
kgryte marked this pull request as ready for review November 14, 2026 08:50
@kgryte
kgryte requested a review from a team November 14, 2026 08:50
@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Nov 14, 2026
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Nov 14, 2026
@kgryte kgryte changed the title docs: use level-four API signature headings in array/base/take-map, array/base/to-inserted-at, array/base/with, and array/base/without docs: fix heading levels Nov 14, 2026
@kgryte
kgryte merged commit 7dc1831 into develop Nov 14, 2026
50 checks passed
@kgryte
kgryte deleted the claude/cool-johnson-c92dlq branch November 14, 2026 08:51
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Nov 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants